ilia/Jobber
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Jobber/docs-site/versioned_docs/version-0.1.20/reference/documentation-style-guide.md
Shaheer Sarfaraz 1f929dfc7f
Create the setup for the documentation page (#171) 
* don't run for generated docusaurus

* format

* workflow to autoupdate docs version

* fix versioning

* add link back to app

* remove old docs

* html link???

* don't track .docusaurus

* documantation build
2026-02-15 22:50:52 +00:00

698 B
Raw Blame History

id, title, description, sidebar_position
id title description sidebar_position
documentation-style-guide Documentation Style Guide Standards for writing user-facing docs in this repository. 2

Use this structure for feature pages:

  1. What it is
  2. Why it exists
  3. How to use it
  4. Common problems
  5. Related pages

Frontmatter requirements

Every doc should include:

  • id
  • title
  • description
  • sidebar_position

Writing rules

  • Prefer concrete steps over abstract prose.
  • Provide copy-pasteable examples.
  • State defaults and constraints explicitly.
  • Link related docs using /docs/... URLs.

PR expectations

Any user-visible behavior change should include matching docs updates.