Repository navigation
spec 0071 (2/2): the reference beside the console, in the guide and the example - #242
Merged
Merged
Conversation
…he example
docs/reference.md's "Which page reads it" said neither page was
configured beyond the API's title; it now shows a Redoc reference beside
Swagger UI in a look of its own, what options, logo and stylesheet do,
the redoc { } form for a Redoc docs page, the refusals, and that the
page is light on white whatever the reader's colour scheme.
The example's ordersDocs serves Swagger UI at /api-docs and a reference at
/reference in a teal theme with Inter and a logo carried as a data: URI,
and ReferenceBesideConsoleTest serves ordersDocs over a socket.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Second and last entry of spec 0071 (
specs/0071-a-reference-with-its-own-look.md):spec-0071-docs.What changes
docs/reference.md. The "Which page reads it" section used to say neither page was configured beyond the API's title. It now covers:options,logoandstylesheeteach do;redoc { }for a Redoc docs page;ordersDocsserves Swagger UI at/api-docsand a reference at/reference. The reference uses a teal theme with Inter, and a logo carried as adata:URI.ReferenceBesideConsoleTestservesordersDocsover a socket.Done when
docs/reference.mdshows the block../gradlew buildpasses locally: 1,814 tests.🤖 Generated with Claude Code