Open source

Keep the manual beside the code

Documentation and source code side by side

Documentation belongs in the project

OSBlog stores guides as Markdown in docs/. The server bundles these files into the same application as the blog.

A pull request can update the feature, its tests, and its instructions together. There is no separate CMS account for the documentation.

Start small

Explain how to run the project, configure it, and recover from a failed release. Add examples from real use. Keep known limitations visible.

Read the deployment guide before publishing your own installation.

CONVERSATION

Leave a note

Email is used only for moderation and is never published.

Never shown publicly.