Refactor docs to cover env vars and introduce How-Tos#2407
Open
sirosen wants to merge 2 commits into
Open
Conversation
This is a new page in our reference docs, focused only on documenting env vars.
This change moves the custom compile command doc out of the readme and onto a new page. Along with it, add a short description of `--no-header`. This also introduces the How-To pages as a new section, which is noted in a changelog fragment.
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.
Quick Review Link: PR Build
There are two changes included here, both in service of the same short-term
goal: remove
CUSTOM_COMPILE_COMMANDfrom the readme.Longer term, we are setting up two new pieces of documentation we can build
upon:
Commits:
Inspired by #2382
Contributor checklist
Included tests for the changes.changelog.d/(seechangelog.d/README.mdfor instructions) or the PR text says "no changelog needed".
Maintainer checklist
bot:chronographer:skiplabel.(following Semantic Versioning).