Skip to main content

DeltaFM Developer Docs

This site is the internal documentation hub for the DeltaFM Facilities Maintenance application.

Start here

The first documents in this knowledge base cover engineering workflow and authentication architecture.

How this is organised

Documentation in Docusaurus lives in the docs/ directory. Each Markdown file becomes a page, and folders become sidebar categories when you use an autogenerated sidebar.

For example:

docs/
intro.md
engineering/
_category_.json
git-branching-strategy.md
authentication/
_category_.json
authentication-with-auth0.md
roles-and-permissions.md

How to add more documentation

  1. Create a new Markdown file under docs/.
  2. Add front matter such as title or sidebar_position when needed.
  3. Group related topics in folders and add a _category_.json file for a clean sidebar label.
  4. Run npm run start to preview changes locally.

Suggested next sections

  • Release management
  • Environments and deployment
  • Pull request standards
  • Coding conventions
  • Local development setup