Add Antora docs; remove personal-repo references - #2
Conversation
Wire docs for the Dev-Centr hub and keep personal forks out of canonical examples. Co-authored-by: Cursor <cursoragent@cursor.com>
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Documentation review — PR #2
Solid foundation: Antora component scaffold, hub-ready docs/antora.yml, and removal of personal-repo references from README, CONTRIBUTING, and RULES.md align with org policy (general/antora-docs-sites.md). The component is already listed in dev-centr/docs antora-playbook.yml.
What looks good
- Clear index/usage/architecture split with accurate
devcentr-agent-rulesboundary - Generic fork guidance replaces personal fork examples
- Mermaid architecture diagram matches README intent
Gaps identified (addressed in follow-up PR on cursor/documentation-automation-system-675a)
| Gap | Standard | Follow-up |
|---|---|---|
| No changelog | general/creator.md requires timeline + changelog-details/ |
Added changelog.adoc + backfilled entries |
| README docs badge | Centered header should include [Docs | Dev-Centr] badge |
Added shields badge linking to hub |
| Thin operational docs | Profiles, assembly flow, troubleshooting | Added profiles, assembly, modules-reference, troubleshooting pages |
| README Changelog section | README should link changelog | Added section → hub changelog URL |
Org-level note (not blocking this PR)
dev-centr/docs playbook uses Valentus theme and @antora/lunr-extension but not yet antora-supplemental/antora-ai-help-extension. Adding AI search requires a cross-repo playbook change in dev-centr/docs.
Recommendation
Approve PR #2 for the scaffold and personal-ref cleanup. Merge or rebase the documentation automation follow-up for changelog and expanded pages before or shortly after.
Sent by Cursor Automation: Generate docs
|
|
||
| Docs: https://docs.devcentr.org/agent-rules/ | ||
|
|
||
| **Dev-Centr product behavior** (when the app acts on behalf of the user) does **not** live here. It belongs in [dev-centr/devcentr-agent-rules](https://github.com/dev-centr/devcentr-agent-rules). |
There was a problem hiding this comment.
Plain-text docs URL is helpful, but layout standards (general/readme-layout.md) expect a Docs | Dev-Centr shields badge in the centered header block (alongside contributors/forks/stars/issues). A follow-up PR adds img.shields.io/badge/docs-Dev--Centr-22c55e linked to the hub.
| @@ -0,0 +1,3 @@ | |||
| * xref:index.adoc[Overview] | |||
| * xref:usage.adoc[Usage] | |||
| * xref:architecture.adoc[Architecture] | |||
There was a problem hiding this comment.
Nav stops at overview/usage/architecture. For a rules repo, operators also need profiles, assembly (1-step parallel read), module index, troubleshooting, and changelog — all required or strongly implied by general/creator.md and RULES.md. Follow-up PR expands nav to eight entries.
| @@ -0,0 +1,7 @@ | |||
| = Usage | |||
|
|
|||
| . Clone into your code hive, for example `$CODE_ROOT/github.com/<your-org-or-user>/agent-rules`. | |||
There was a problem hiding this comment.
Usage is accurate but minimal. Consider cross-linking profile setup, assembly order (MAIN.md parallel reads), and common pitfalls (wrong ENVIRONMENT, MEMORIES location). Follow-up adds profiles.adoc, assembly.adoc, and troubleshooting.adoc.
1 participant
Summary
docs/Test plan