Repository navigation
docs(readme): add 'Built to be forked' section explaining the rebrand path - #35
Merged
Merged
Conversation
… path The firn-explorer README pitched itself as a 'reference frontend' but gave consumers no concrete guidance on how to make it theirs. New section walks through four customization paths: - Swap branding assets (firn.png, OKLCH tokens, app/layout.tsx) - Add new pages against firn's typed OpenAPI client (orval regenerates on firn API changes) - Drop or rewrite any of the existing routes - Wire decoded surfaces by extending firn with a custom decoder Closing line frames the explorer's job: faithful renderer of firn's API. Everything cosmetic is yours to change.
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.
Adds a section that gives consumers concrete guidance on how to customize firn-explorer for their L1: swap branding assets, regenerate against firn's OpenAPI on schema changes, drop or rewrite any of the existing routes, wire decoded surfaces by extending firn with a custom decoder.
Closing line frames the explorer's job: faithful renderer of firn's API. Everything cosmetic is yours to change.