webarkit / webarkit/webarkit.github.io
Host API documentation for WebARKit libraries (jsfeatNext first) on webarkit.org
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 12
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
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 webarkit/jsfeatNext#71).- 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 ongh-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? - Automation: jsfeatNext is about to get a tag-triggered release workflow (webarkit/jsfeatNext#61) — a docs-publish step would slot naturally into it.
- Consistency: TypeDoc for the TypeScript repos; other tooling may be needed for the C/C++/emscripten repos.
Acceptance criteria
- A documented decision on where org API docs live and how repos publish to it
- jsfeatNext docs published there as the pilot
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with jsfeatNext's npm run docs command and generated docs/api/ output, then review the three hosting options and the planned tag-triggered release workflow. Compare versioning, automation, and consistency across the WebARKit repositories. Done means documenting one hosting and publishing decision and publishing jsfeatNext as the pilot.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, github-actions, typescript
- Domain
- ci-cd, documentation, release
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100