Repository navigation
docs: fix stale image paths in the contributing guide - #1304
Open
AllanBandeira91 wants to merge 1 commit into
Open
AllanBandeira91 wants to merge 1 commit into
AllanBandeira91 wants to merge 1 commit into
Conversation
This branch has not been deployed
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
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.
What this fixes
Closes #1241.
The Images section of the contributing guide tells contributors to put images
in
/static/images, but this repository has nostatic/directory — the staticdirectory is
public/(staticDirectories: ["public"]indocusaurus.config.ts).It also implied that every image should be linked with
/images/, while 1,482references across
docs/point at the CDN(
https://assets.open.mp/assets/images/...), which is where theupload-assetstask in
Taskfile.ymlpublishesfrontend/public/images.Changes
/static/images→public/images(the actual directory)its→it's)Verification
npm run build -- --locale enpassesI intentionally did not touch the 19 translations of this page; happy to open a
follow-up per locale after this one lands.