Link index.md to current version of the spec #448
Conversation
This file contains 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
Use the `current_version` field in `_config.yml` to automatically link
the index.md (the 'homepage') to the current version of the spec.
This prevents possible sync errors between spec/v<current-version>.md
and index.md.
Current situation:
$ diff --report-identical-files index.md spec/v2.0.0.md
Files index.md and spec/v2.0.0.md are identical
Jekyll handles this as it includes spec/v<current-version>.md. See 1cbf02a
This was referenced Jul 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Use the
current_versionfield in_config.ymlto automatically link the index.md (the 'homepage') to the current version of the spec.This prevents possible sync errors between spec/v.md and index.md.
Current situation:
PR Checklist
specdir.npm run lint.(Optional) If you're willing to help reviews about your language's translations, add your name to theTRANSLATORS.md.