docs: Documenter.jl site (sibling PiccoloDocsTemplate pattern)#6
Draft
aarontrowbridge wants to merge 2 commits into
Draft
docs: Documenter.jl site (sibling PiccoloDocsTemplate pattern)#6aarontrowbridge wants to merge 2 commits into
aarontrowbridge wants to merge 2 commits into
Conversation
Mirror the Intonato.jl docs pattern for the public IntonatoQICK.jl package: docs/Project.toml, docs/make.jl, docs/get_docs_utils.sh, docs/src/index.md, docs/src/lib.md, and .github/workflows/docs.yml. The home page is authored from the README (three-verb hardware boundary, mock example, PyQickSoc swap) and the API page is an @autodocs of the IntonatoQICK module. The concrete tuning/convergence strategy is described by capability only and noted as shipping separately; only public symbols are documented. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Draft — do not merge. Scaffolds a Documenter.jl docs site for IntonatoQICK, matching the
sibling pattern (Piccolo/Intonato →
PiccoloDocsTemplate), so the public QICK backend gets aproper docs site like the rest of the stack.
Contents
docs/{Project.toml, make.jl, get_docs_utils.sh, src/index.md, src/lib.md}+.github/workflows/docs.yml,all adapted 1:1 from Intonato (module/UUID/repo-slug → IntonatoQICK; canonical
docs.harmoniqs.co/IntonatoQICK.jl).index.md: what it is, the coarse 3-verb boundary, the README's mock example, thePyQickSocswap,status;
lib.md:@autodocsAPI reference.Public-safe
Leak-checked (independently): no
Intonatissimo/ILCStrategy/QILC-method/private-path strings. Theconcrete tuning/convergence strategy is described by capability only ("supplied separately, in an
entitlement-gated package") — funnel, not method.
IdentityStrategy/AbstractTuningStrategyare publicIntonato exports.
Reviewer caveats
PiccoloDocsTemplateis an unregistered git dep pinned to v0.7.0 inCI; the local depot only has v0.2/v0.3, so
julia docs/make.jlwon't resolve offline. This PR'sdocs.yml CI run is the first real build — expect to iterate if Documenter flags anything.
make_index=false+ a committedindex.md(Intonato uses the templatedefault
make_index=true, which regenerates index from the README at build time). Kept a richerhand-authored page; to match siblings exactly, delete
index.mdand drop themake_index=falseline.