You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Decide and set up a hosting strategy for API documentation of the WebARKit org's repositories, integrated with www.webarkit.org — starting with jsfeatNext, whose full API docs are now generatable.
The generated output is deliberately gitignored and not published anywhere yet.
Publishing via the repo's own GitHub Pages was ruled out: the org's web presence is www.webarkit.org (served from this repository), so docs should live under/next to it rather than on scattered per-repo pages.
Other WebARKit repos (webarkit core, jsartoolkitNFT, etc.) will want the same treatment, so this should be a single org-wide pattern, not a per-repo improvisation.
Options to evaluate
Subpaths on this site — e.g. webarkit.org/docs/jsfeat-next/, webarkit.org/docs/<repo>/: each library repo has a CI job that builds its docs and pushes them into this repository (or uploads an artifact this repo's build consumes).
Docs subdomain — e.g. docs.webarkit.org, a dedicated docs site (could still be GitHub Pages under the hood, on a separate repo/branch) aggregating all libraries.
Per-repo gh-pages + central index — each repo publishes its own docs on gh-pages; www.webarkit.org just links to them (least integration, least central control).
Considerations
Versioning: publish docs per release tag (e.g. /docs/jsfeat-next/0.7.6/ + latest) or only latest?
Summary
Decide and set up a hosting strategy for API documentation of the WebARKit org's repositories, integrated with www.webarkit.org — starting with jsfeatNext, whose full API docs are now generatable.
Context
jsfeatNextnow has complete TSDoc coverage across its API and a TypeDoc setup:npm run docsgenerates a full static HTML site (86 pages) intodocs/api/(see refactor: de-duplicate the stub/monolith structure — one real module per class (#47) jsfeatNext#71).Options to evaluate
webarkit.org/docs/jsfeat-next/,webarkit.org/docs/<repo>/: each library repo has a CI job that builds its docs and pushes them into this repository (or uploads an artifact this repo's build consumes).docs.webarkit.org, a dedicated docs site (could still be GitHub Pages under the hood, on a separate repo/branch) aggregating all libraries.gh-pages+ central index — each repo publishes its own docs ongh-pages; www.webarkit.org just links to them (least integration, least central control).Considerations
/docs/jsfeat-next/0.7.6/+latest) or only latest?Acceptance criteria