Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Host API documentation for WebARKit libraries (jsfeatNext first) on webarkit.org

Aperta
  • Qualcosa non va?
#49 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
45/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
github, github-actions, typescript
Ambito
ci-cd, documentation, release

Direzione di ricerca

Inizia con il comando npm run docs di jsfeatNext e l’output generato in docs/api/, quindi esamina le tre opzioni di hosting e il workflow di pubblicazione pianificato, attivato dai tag. Il lavoro sarà completato quando sarà documentata una decisione sull’hosting e sulla pubblicazione e jsfeatNext sarà pubblicato come progetto pilota.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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

  • jsfeatNext now has complete TSDoc coverage across its API and a TypeDoc setup: npm run docs generates a full static HTML site (86 pages) into docs/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

  1. 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).
  2. 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.
  3. 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?
  • 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
Lingua principale
JavaScript
Stelle
12
Fork
2
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di webarkit/webarkit.github.io

Tutte le issue di webarkit/webarkit.github.io

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.