Greg Erskine wrote: > No one likes doing documentation. > > The future. We are investigating other options with these required > features: > > 1. Documents use markdown. > 2. User input via basic text files. > 3. Source managed by git. > 4. Local staging server. > 5. Automated pushing to production from GitLab. > 6. Potentially, in future, for user input direct via GitLab. > 7. Everything has to be fast. > 8. No day to day management of system or users.
^^^ This. Seems like a fairly standard, run-of-the-mill docs-as-code approach. I applaud this. Given that the structure of the pCP docs is not terribly large or complex, this approach should be easy to implement and, importantly, maintain. By hosting it on GitLab I anticipate interested, docs-minded people can make pull requests and file issues. (Truth be told, I haven't looked to see if the current project allows PRs for docs.) I'm looking forward to seeing where this Docs As Code approach leads you. It's the world I live in, although usually working with more semantically-rich languages than just Markdown, although Markdown has played a part in some projects I've done. ------------------------------------------------------------------------ prabbit's Profile: http://forums.slimdevices.com/member.php?userid=11142 View this thread: http://forums.slimdevices.com/showthread.php?t=112712 _______________________________________________ unix mailing list [email protected] http://lists.slimdevices.com/mailman/listinfo/unix
