Skip to content

feat: docs page at /docs.html - #21

Merged
melvincarvalho merged 1 commit into
gh-pagesfrom
feat-docs-page
May 16, 2026
Merged

melvincarvalho merged 1 commit into
gh-pagesfrom
feat-docs-page

Conversation

@melvincarvalho

Copy link
Copy Markdown
Contributor

Summary

Adds a single-page `docs.html` covering what jspod ships, where things live, and how to customize. Linked from the welcome and account page footers.

What's in it

  • What jspod is — positioning vs JSS
  • File layout — annotated tree of `pod-data/` showing which files are jspod-owned (overwritten every start), skip-if-exists (user content survives), and JSS-seeded
  • Where .idp lives — accounts/ + keys/, what's in them, sensitivity
  • Customize the landing page — honest about the overwrite limitation and current escape hatches (fork, run JSS direct, track JSS#459)
  • Auth ladder — reference to #6 and `JSS_SINGLE_USER_PASSWORD` override
  • Backup & reset — `tar -czf` for backup, `rm -rf pod-data` for full reset
  • Bundled apps — Pilot's location, skip-if-exists semantics
  • Links — jspod, JSS, solid-oidc, Solid project & spec

Same overwrite + public-read pattern as signin.html / account.html. Footer link is now `Docs · Powered by jspod` on welcome and account.

Test plan

  • Local: docs.html + .acl ship and serve unauthenticated
  • Welcome footer has Docs link → /docs.html
  • Account footer has Docs link → /docs.html
  • Page renders with proper layout, TOC, file tree, callout warnings

Bumps jspod to 0.0.23. Future: when the docs page graduates to its own URL (e.g. jss.live/jspod/docs.html), this in-pod copy can become a redirect or live alongside as offline-safe reference.

Refs #1

A single-page docs document covering what jspod ships, where things
live, and how to customize. Same overwrite + public-read pattern as
the other jspod-owned static pages. Linked from the welcome and
account page footers.

Sections:
- What jspod is (positioning vs JSS)
- File layout — annotated tree of pod-data/ with notes on which
  files are jspod-owned (overwritten every start) vs skip-if-exists
  (user content survives) vs JSS-seeded
- Where .idp lives — accounts/ + keys/, what's in them, sensitivity
- Customize the landing page — honest about the overwrite limitation
  and the three current escape hatches (fork, run JSS direct, track
  upstream issue #459)
- Auth ladder — reference to issue #6 and the JSS_SINGLE_USER_PASSWORD
  override
- Backup & reset — tar -czf for backup, rm -rf pod-data for full
  reset (since /idp/account/delete is disabled in single-user mode)
- Bundled apps — Pilot's location, skip-if-exists semantics, how to
  pin or upgrade
- Links — jspod, JSS, solid-oidc, Solid project & spec

Bumps jspod to 0.0.23.

Refs #1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant