-
Notifications
You must be signed in to change notification settings - Fork 0
Wiki Publishing
Markdown under docs/ is the source of truth. GitHub Wiki is a generated read surface, not a second authoring location.
On a successful push to main that changes managed documentation or Wiki tooling, .github/workflows/wiki.yml:
- checks out the repository;
- runs
npm run docs:check; - clones
https://github.com/sidhxntt/Praxis.wiki.git; - renders managed pages into the Wiki checkout;
- commits and pushes only when content changed.
The repository Wiki must be enabled and initialized with one page before its Git repository exists. The workflow uses the repository-scoped GITHUB_TOKEN; repository settings must allow Actions write access.
npm run docs:check
wiki_dir="$(mktemp -d)"
npm run docs:wiki -- "$wiki_dir"
find "$wiki_dir" -maxdepth 1 -type f -print | sortInspect at least Home.md, _Sidebar.md, Code-Architecture.md, and Generated-Backends.md before publishing a structural change.
| Source | Wiki page |
|---|---|
docs/index.md |
Home |
docs/overview.md |
Overview |
docs/architecture.md |
Architecture |
docs/terminology.md |
Terminology |
docs/repository-map.md |
Repository-Map |
docs/code-architecture.md |
Code-Architecture |
docs/generation-pipeline.md |
Generation-Pipeline |
docs/manifest-system.md |
Manifest-System |
docs/standard-projects.md |
Standard-Projects |
docs/praxis-pro.md |
Praxis-Pro |
docs/generated-backends.md |
Generated-Backends |
docs/ui-templates.md |
UI-Templates |
docs/testing.md |
Testing |
docs/agent-guide.md |
Agent-Guide |
docs/wiki-publishing.md |
Wiki-Publishing |
The renderer also manages _Sidebar.md and _Footer.md. It does not delete other Wiki files; obsolete unmanaged pages must be reviewed and removed deliberately.
- Change source Markdown, never only the Wiki copy.
- Keep source links repository-relative so they work on GitHub and can be validated locally.
- Mark future direction explicitly and never mix it into current architecture diagrams.
- Do not include credentials, private deployment data, or raw incident logs.
- Update the page map, sidebar, renderer, and link tests together when adding a page.
This Wiki is generated from the repository's versioned docs/ source. Update and review the source files; do not rely on hand edits to generated Wiki pages.
- Core-Internals
- Architecture
- Repository-Map
- Code-Architecture
- Generation-Pipeline
- Manifest-System
- UI-Templates
- Testing
- Agent-Guide
- Wiki-Publishing
- Template-Architecture
- Standard-Projects
- Standard-Frontend-Architecture
- Express-Architecture
- Fullstack-Architecture
- Praxis-Pro
- Django-Architecture
- Gin-Architecture
- Capability-Architecture
- Compose-Architecture
- Kubernetes-Architecture
- Terraform-Architecture
- Extending-Generated-Projects
- Generated-Backends