Skip to content

docs: update OpenWiki #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Gram21 merged 1 commit into from
Oct 19, 2026
Merged

docs: update OpenWiki #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
<!-- OPENWIKI:START -->

## OpenWiki

This repository has documentation located in the /openwiki directory.
This repository has a generated `openwiki/` evidence index. It is optional just-in-time context, not required startup reading.

Start here:
- [OpenWiki quickstart](openwiki/quickstart.md)
- Do not enumerate, preload, or search wikis at task start. Use retrieval when the user asks for it, when unfamiliar architecture or dependency behavior materially affects the task, or when source inspection leaves an important uncertainty. Stop once the question is grounded.
- When those conditions apply and OpenWiki retrieval tools are available, use `openwiki_search` for just-in-time context and `openwiki_read` for the relevant complete sections. If search returns `workspace_required`, ask which listed workspace to use and retry with its ID.
- Use `openwiki_list_workspaces` or `openwiki_list_wikis` when workspace membership itself needs to be discovered.
- If the retrieval tools are unavailable, read `openwiki/quickstart.md` and follow its links to the relevant pages.
- Treat source code and tests as authoritative. A brief's unknowns and review items are verification gaps, not automatic requirements.
- Prefer the narrowest quiet validation that proves the changed behavior. Preserve complete failure output.

OpenWiki includes repository overview, architecture notes, workflows, domain concepts, operations, integrations, testing guidance, and source maps.
The scheduled OpenWiki GitHub Actions workflow refreshes the repository wiki. Do not hand-edit generated OpenWiki pages unless explicitly asked; prefer updating source code/docs and letting OpenWiki regenerate.

When working in this repository, read the OpenWiki quickstart first, then follow its links to the relevant architecture, workflow, domain, operation, and testing notes.
<!-- OPENWIKI:END -->
11 changes: 4 additions & 7 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
## OpenWiki

This repository has documentation located in the /openwiki directory.
<!-- OPENWIKI:START -->

Start here:
- [OpenWiki quickstart](openwiki/quickstart.md)
## OpenWiki

OpenWiki includes repository overview, architecture notes, workflows, domain concepts, operations, integrations, testing guidance, and source maps.
@AGENTS.md

When working in this repository, read the OpenWiki quickstart first, then follow its links to the relevant architecture, workflow, domain, operation, and testing notes.
<!-- OPENWIKI:END -->
6 changes: 3 additions & 3 deletions openwiki/.last-update.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"updatedAt": "2026-08-25T11:50:13.234Z",
"updatedAt": "2026-10-19T12:22:48.633Z",
"command": "update",
"gitHead": "2e12ede80c5b3dd568da133ed3cc78cee2bdd34d",
"model": "z-ai/glm-5.2",
"status": "complete",
"model": "z-ai/glm-5.3-flash",
"status": "interrupted",
"language": "en"
}