docs: point at docs.getcassis.com, keep the examples - #1
Open
AloysAugustin wants to merge 1 commit into
Open
Conversation
The prose here duplicated what the docs site now covers, and had drifted: it advertised cassis-cli 0.2.0, said there is no automatic reformatter (cassis ontology fmt has existed since 7.17), and claimed non-YAML files in the ontology directory don't survive an export (7.18 preserves them). Rather than maintain two copies, reduce docs/ to stubs that map each old section to its page on docs.getcassis.com, so links people already have still land somewhere useful. Both corrections are called out in the stubs that carried the wrong claim. The authoring guide is not on the site either: that doctrine ships inside cassis-cli and lands in a checkout as cassis/AGENTS.md, which is what a repo-aware coding agent reads. Its stub says so. What this repo keeps is the part that can't live on a docs site: the two example ontology trees, validated in CI, meant to be copied. README rewritten around them, and the example READMEs now link to the site. Also says "ontology" throughout, matching the product. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JzrkqTM3ZUHScxTsGXjQ2t
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
This repo's prose duplicated what the docs site now covers, and it had drifted:
cassis ontology fmthas existed since 7.17.AGENTS.mdis safe there.ontology test,eval add-case,pull,AGENTS.md, and the Agent setup page.Rather than maintain two copies, the docs site is now the single source of truth: GetCassis/website#54 ports this content, corrections included.
What changed
docs/reduced to stubs. Each file maps its old sections to the matching page on the site, so links teammates already have still land somewhere useful instead of 404-ing or, worse, quietly serving stale instructions.how-it-works.mdgetting-started.mdrepository-layout.mdfile-reference.mdworkflow.mdauthoring-guide.mdcassis/AGENTS.md(see below)The two stubs that carried a wrong claim call the correction out explicitly, since someone may have acted on it.
The authoring guide is not on the site either. That doctrine ships inside cassis-cli and lands in a checkout as
cassis/AGENTS.md, which is what a repo-aware coding agent actually reads. Duplicating it on a web page would just create a third copy to drift. The stub explains where it comes from and how to refresh it.What this repo keeps is the part that can't live on a docs site: the two example ontology trees, validated in CI, meant to be copied. The README is rewritten around them.
Housekeeping: example READMEs link to the site instead of
../../docs/*.md, the validate workflow's comment points at /cli#ci for the GitLab variant and the eval-gate job, and everything says "ontology".Not changed
examples/minimal/andexamples/stallora/trees, and.github/workflows/validate.yml's steps. The CI check still validates both trees on every push and pull request.🤖 Generated with Claude Code
https://claude.ai/code/session_01JzrkqTM3ZUHScxTsGXjQ2t