How this works

It’s pretty simple. You write notes / documentation in markdown files, and they get rendered into a pretty website. The markdown files are to be located in the documentation/src/content/docs directory.

The hosted page is statically generated and hosted on Ben’s dev server based on the main development branch. Expect up to a few minutes delay for your pushed changes to show up on the website. You can always run the website locally to see your changes immediately, but it is not required to do so as it’s pretty hard to screw up the website by adding a .md file somewhere.

Expectations

Overall, you should probably:

• Write about what you do.
• Explain how you did things
• Explain non-trival / complex code (such as a reusable component or function)
• Use markdown formatting (See: Markdown guide for reference)
• Use the provided template (See: Documentation template for reference) to ensure that you include the necessary frontmatter and formatting.

It’s somewhat optional, but it would be a bit more professional to write in third-person.

Anti-Expectations (Things to NOT do)

• Write irrelevant information that doesn’t correspond to the codebase or project.
• Regurgitate common high level concepts that are easily googleable and not specific to this project (e.g. “Astro is a framework for building websites and Python is a programming language”)
• Push un-proofread AI generated text.

File Handling

• Markdown should be placed in the /src/content/docs directory within the docus website project.
• Images should be placed in the src/assets directory and linked in markdown with it’s relative path.