Skip to content

docs: add How it works section explaining the JSS wrapper split#7

Open
melvincarvalho wants to merge 1 commit into
mainfrom
docs/how-it-works
Open

docs: add How it works section explaining the JSS wrapper split#7
melvincarvalho wants to merge 1 commit into
mainfrom
docs/how-it-works

Conversation

@melvincarvalho

Copy link
Copy Markdown
Contributor

What

Adds a short How it works section right after Why? — the README explained what servejss is for but never what it is relative to JSS. The only hints were the install note about the global-jss fallback and a Related Projects link.

The new section answers "is this a fork? a proxy?" up front:

  • servejss is a thin launcher: it translates serve-style flags into a jss start invocation, runs it in --public mode against your directory, handles port switching, banner, and the child process
  • every request is handled by JSS — servejss has no proxy or middleware, so request-behavior issues (ETags, git backend, Solid features) belong upstream
  • --solid drops the public default and starts JSS as a full authenticated Solid server

Docs only, no code changes.

Answers 'is this a fork? a proxy?' up front: servejss is a thin
launcher that translates serve-style flags into a jss start invocation
and never touches requests. Spells out what lives in the wrapper (CLI,
public-mode defaults, port switching, banner, child process) vs
upstream JSS (all request handling and Solid features), so behavior
issues get filed in the right repo.
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