| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [View Raw Code] [Original HTTPS Page] |
This folder contains both the repository's engineering documentation and the public Docusaurus documentation site.
The Docusaurus project lives in this folder, following the same single-repository layout used by TUnit:
| Path | Role |
|---|---|
| docs/ | Public, user-facing Markdown consumed by Docusaurus |
| docusaurus.config.ts | Site configuration |
| sidebars.ts | Public navigation |
| src/ | Site theme and custom UI |
| static/ | Site assets |
From this directory:
bun install
bun run start
bun run buildbun run build writes the generated site to docs/build/. Do not edit that generated directory. The public Markdown is intentionally separate from the engineering source-of-truth below; link to product and architecture documents when deeper detail is needed.
CI workflow .github/workflows/Docs.yml builds on PRs and deploys to GitHub Pages on push to develop / main (and workflow_dispatch).
One-time repo setting: Settings → Pages → Source = GitHub Actions. Site URL: https://trgiangv.github.io/RevitDevTool/
Start here when locating repository truth. Retrieve only what the task needs.
| Path | Role |
|---|---|
| WORKFLOW.md | Request shape, judgment, validation, completion |
| product/ | Current product behavior contracts |
| ARCHITECTURE.md | Structural index → architecture/ |
| plans/ | Durable multi-session working memory |
| decisions/ | Lasting product and architecture choices |
| templates/ | Exec-plan and decision templates |
| Path | Role |
|---|---|
| architecture/ | Deep module design (Execution, MCP, PyTest, Testing, Logging, Visualization, …) |
| agents/ | Agent task router and operational digests |
| static/ | Icon and installer assets (not behavioral truth) |
| I want to… | Read |
|---|---|
| Choose how to work on a request | WORKFLOW.md |
| Know current platform behavior | product/overview.md |
| Route an agent task | agents/index.md |
| Understand a module deeply | ARCHITECTURE.md |
| Resume complex work | plans/active/ |
| Inherit a lasting choice | decisions/ |
| End-user guides | Docusaurus site |
Do not duplicate the same fact across layers; link instead.
| Back | FazBrowse Home | New Git URL |