Document the landing site - #10
Merged
Merged
Conversation
`landing` is the org's newest repo — the marketing page that explains Space Console to someone who has never seen it. Add it to the services index and the build-status badges, and give it a docs folder like every other service. The getting-started page carries the part that isn't obvious from the code: every screenshot on that site is a real capture of the running console, and the recipe for recapturing it (single-origin server, a host-resolver rule so the launcher's own readout renders the production hostname, and real controllers joining so the roster and the in-game HUD are genuine). It also flags that the room code is regenerated each session and has to be re-synced into the page copy afterwards.
Contributor
|
📚 Docs preview for |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
landingis the org's newest repo — the marketing page that explains SpaceConsole to someone who has never seen it. This adds it to the index and gives it
a docs folder like every other service.
docs/repositories.md— a row in the services table (noting that it's alsowhat the deployed site root serves) and a row in the build-status badges
docs/services/landing/— Overview / Getting started / Architecture, plusits
toc.ymldocs/services/toc.yml— the nav entryThe getting-started page carries the part that isn't obvious from reading the
code: every screenshot on that site is a real capture of the running console,
and the recipe for recapturing it —
web-api'sserve:app)--host-resolver-rules=MAP space-console.onrender.com:80 127.0.0.1:8000so the launcher's ownlocation.hostreadout renders theproduction hostname, with nothing retouched afterwards
It also flags the trap: the room code is regenerated every session, so after a
recapture the code baked into the page copy has to be re-synced — it appears in
six places including the pseudo-QR seed.
Related: landing#1 ·
web-api#9