Repository navigation
Description
This was generated by AI during triage.
Current status (2026-09-29)
Inspected baseline: main@b64bb2f.
Status: public documentation site not shipped. npm installation is now available and should be documented as released.
Repository docs and portable installed skills already describe the supported workflow. @jdylanmc/topo-code@0.1.0 and its exact renderer dependency are public; no source checkout is required for consumers. Several repository pages still use initial-candidate/pre-publication wording and need an accurate post-release refresh.
Acceptance
-
Publish navigable public documentation after the owner chooses hosting, domain, and documentation tooling.
-
Provide a Node.js 22+/Git getting-started path using
npm install --save-dev @jdylanmc/topo-code@0.1.0,topo init --skills, scan, serve, story authoring/validation/preview, and static bundling. -
Document supported CLI/configuration, project-skill installation and preservation, source-grounded versus conceptual diagrams, and current limitations separately from planned scope.
-
Correct stale candidate/pre-publication wording in the README, product-spec distribution status, and release/development guidance. Keep the historical bootstrap procedure as history rather than implying the packages still need first publication. Preserve accurate source-development setup and unresolved acceptance commitments.
-
Link to GitHub/npm and coordinate discoverability with Build a public Topocode marketing site #74.
This is documentation, not permission to invent product behavior, silently waive #41/#42/#43/#46 acceptance, or choose hosting without the owner. Public-registry publication is verified; private registry mirror availability is a separate environment condition. Trusted publishing/token administration belongs to #82, not the consumer installation prerequisites.
Evidence: published distribution manifest, release procedure, README, and successful publication/install run.
Previous issue text and original requirements (historical; current disposition is above)
Outcome
Publicly accessible, maintained documentation that helps users understand, set up, and use Topocode without relying on this repository's agent context.
Acceptance
- A public documentation site with clear navigation and a getting-started guide.
- Document setup, source-grounded story authoring, validation, preview, and static bundling.
- Include supported CLI usage and configuration; distinguish currently available capabilities from planned work.
- Link to the GitHub repository and make the docs discoverable from the public marketing site.
Scope
Documentation only; keep existing repository guidance as a starting point. Hosting, domain, and documentation tooling remain to be decided. Public npm installation instructions should match the release delivered by #13 rather than claim an unreleased package exists.
Related
#13 - npm packaging and distribution.
#74 - public marketing site.
Activity
jdylanmc commentedon Sep 29, 2026
Backlog reconciliation (2026-09-29)
Made public npm consumption the documentation baseline and explicitly captured the stale candidate/pre-publication wording as remaining documentation work. The public documentation site and its hosting/tooling decisions remain open.
Evidence and preserved historical requirements are in the updated issue body. Baseline:
main@b64bb2f. No repository source or credential changes.jdylanmc commentedon Oct 2, 2026
Public repository-backed docs are live at https://jdylanmc.github.io/topo-code/docs/ via merged PR #87. Includes getting started, installation, CLI/configuration, authoring/evidence, Rust/Tauri limits, and additional reference docs. Main deployment36966900170 succeeded and public docs navigation was browser-verified. New repository-only story/layout features remain explicitly marked unreleased relative to npm0.2.0.