Docs

justin-napolitano/portfolio-for-real / README.md

Repository documentation wiki

Synced 2026-10-23 · Updates are made in the source repository.

Repository documentation wiki

The public documentation at https://docs.jnap.me is a reading layer over repository-owned Markdown. Edit the original file using Edit source on any page; do not edit the generated catalog.

Publish documentation

  1. Write a root README.md or Markdown/MDX file under docs/ in a public repository.
  2. Add the repository to docs-sources.json if it is not already listed. Review its publishing scope first.
  3. Merge source changes. Sync checks every six hours, or run Actions → Sync repository documentation → Run workflow. GitHub schedules can be delayed.
  4. A changed snapshot is committed to data/federated/catalog.json; the connected Vercel project builds that commit.

Frontmatter draft: true, private: true, publish: false, or visibility: internal prevents publication. Planning, governance, branding, and review evidence paths are excluded; see scripts/sync-docs.py for exact rules. Never rely on publication exclusions to make a public repository confidential.

Development

npm ci
npm run docs:sync
npm run docs:check
npm run docs:test
npx tsc --noEmit
npm run build -- --webpack
npm run dev

Python 3.12 and Node 22 match CI. Sync uses the Python standard library. GITHUB_TOKEN is optional locally for public API rate limits; Actions uses its built-in token. The wiki builds and searches from the committed snapshot without a database or credentials.

See federation and recovery. Legacy database-backed project detail URLs remain as a marked archive; /projects redirects to the wiki. Old commit-log integrations are retained for compatibility and do not supply wiki content.

Project log

/log lists every public repository, including experiments, forks, and archives. project.json in each source repo optionally supplies its title, summary, lifecycle, topics, and reading order. See the documentation standard. Refresh with npm run projects:sync; validate with npm run projects:check. The six-hour sync refreshes both public catalogs.

The private wiki guide covers owner-local snapshots, full-text search, source navigation, and the separate hosted authentication boundary. Private outputs are never committed here.