Conversation
Sphinx + MyST under docs/, built straight from the Markdown (no mdoc); 24 pages covering usage, built-in flows, settings, authoring, API, glossaries and development. README keeps the intro, install and first run. The shell bundles the concatenated docs instead of the README as the authoring agent's reference. A docs CI job runs sphinx-build -W.
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.
Adds a Read the Docs site under
docs/and cuts the README down to a quick start.Docs site
docs/(.readthedocs.yaml,docs/conf.py,requirements.txt,Makefile,watch.sh), the same setup as sttp-ai minus mdoc. Orca's snippets are scala-cli scripts, so there is nothing for mdoc to compile;sbt updateDocsnow walksdocs/to bump the version pins on release.https://orca.virtuslab.com. The Read the Docs project and the custom domain still need to be created on the RTD side.docsCI job runssphinx-build -W, so a broken link or toctree entry fails CI.README
Intro kept as is, then install, first run, one example flow, and pointers to the docs. The old example had a scoping bug (it reused a per-task
sessionin the final review); the example and the tutorial now mint afinal-fixersession likeflows/implement.scdoes.Shell
orca create/orca forkused to hand the authoring agent the README as its API reference. The build now concatenates the docs pages in toctree order (project/ConcatDocs.scala) intoorca-docs.mdand bundles that instead; the prompts and their tests point at it, and the last-resort URL is thedocs/tree at the build's git ref.Also
AGENTS.md,CONTRIBUTING.mdand the example READMEs point at the docs instead of README sections.🤖 Generated with Claude Code