Skip to content

Docs/use wiki as source#12

Merged
arnav2 merged 1 commit into
mainfrom
docs/use-wiki-as-source
Apr 29, 2026
Merged

Docs/use wiki as source#12
arnav2 merged 1 commit into
mainfrom
docs/use-wiki-as-source

Conversation

@arnav2
Copy link
Copy Markdown
Contributor

@arnav2 arnav2 commented Apr 29, 2026

Summary

Type of change

  • 🚀 New flagship (flagships/<name>/)
  • 🧑‍🍳 New recipe (recipes/<name>/)
  • 🔌 New framework integration (LangChain, LangGraph, CrewAI, Temporal, …)
  • 🐛 Bug fix
  • 📖 Documentation / wiki
  • 🧰 Tooling / CI / dev setup
  • 🧹 Refactor (no behavior change)
  • 💥 Breaking change (describe migration in "Notes")

Related issues

What changed

How to review

# e.g.
CORPUS_FOLDER_ID=<your-folder> make demo-<slug>

Test plan

  • make lint passes
  • make test passes (MCP unit tests)
  • make demo-<slug> runs end-to-end (if flagship/recipe work)
  • Screenshots / sample output attached (if UI-ish or format change)

Checklist

  • I've read CONTRIBUTING.md and the relevant cursor rule
  • No API keys, tokens, or PII in the diff
  • Every non-trivial claim in the agent output is cited (Citation.chunk_id or [chunk:<uuid>])
  • Seed-data expectations documented (either in the flagship README or updating docs/wiki/seed-data.md)
  • Workspace pyproject.toml updated if a new package was added
  • Makefile target added/updated if a new flagship was added
  • CHANGELOG.md updated under [Unreleased]

Notes

The GitHub Wiki at https://github.com/knowledgestack/ks-cookbook/wiki
is now initialized and authoritative. Maintaining a parallel docs/wiki/
in main + a sync workflow added churn for no benefit, so:

- Delete docs/wiki/ entirely (overview, quickstart, frameworks/*,
  book/* — every page lives in the wiki repo).
- Delete the sync infrastructure: .github/workflows/wiki.yml,
  scripts/publish_wiki.sh, scripts/build_wiki_sidebar.py, and
  scripts/build_wiki_book.py (book regenerator).
- Drop 'make tags' regeneration of the wiki book; the target now just
  syncs flagship keywords.
- Rewrite every internal docs/wiki/<page>.md link to the corresponding
  wiki URL (https://github.com/knowledgestack/ks-cookbook/wiki/<page>),
  including README badges and index, the issue templates, the PR
  template, the flagship contributor rule, and one flagship README.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@arnav2 arnav2 requested a review from a team as a code owner April 29, 2026 01:39
@arnav2 arnav2 merged commit e33c002 into main Apr 29, 2026
2 checks passed
@arnav2 arnav2 deleted the docs/use-wiki-as-source branch April 29, 2026 01:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant