-
Notifications
You must be signed in to change notification settings - Fork 991
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: Link to edit has a more descriptive title #5895
Conversation
✅ Deploy Preview for redwoodjs-docs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey @wiksien, thanks for taking this on! These changes aren't actually what we want so sorry if we weren't super clear before. What we want to change is "Edit this page" at the bottom of every doc (just scroll all the way down, you'll see it):
We haven't found an easy way to do that yet that doesn't involve swizzling.
@@ -114,12 +114,12 @@ const config = { | |||
docs: { | |||
sidebarPath: require.resolve('./sidebars.js'), | |||
// ? — blob? tree? | |||
editUrl: 'https://github.com/redwoodjs/redwood/blob/main/docs', // base path for repo edit pages | |||
editUrl: 'https://github.com/redwoodjs/redwood/blob/main/docs/versioned_docs', // base path for repo edit pages |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We want to leave this one as is cause if users edit versioned docs those edits don't propagate to future versions. (Of course some edits shouldn't propagate, but most of the edits we get should.)
editCurrentVersion: true, | ||
remarkPlugins: [autoImportTabs, fileExtSwitcher], | ||
versions: { | ||
current: { | ||
label: 'Canary', | ||
label: 'Edit the Canary version of this page', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @jtoar, thanks for clearing out my misinformation in regards to this issue. I also have no idea how to change the "Edit this page" text at the bottom so if someone feels like digging more into it, feel free! |
@wiksien no worries, thanks for giving it a shot! Were you looking for a good first issue? I could try recommending a different one if so. |
@jtoar Sure thing! Please do recommend me a one. |
For #5727
What it does?
Changed link to point to
/docs/versioned_docs
instead of/docs
plus edited label description to better suit where the link points to.@Tobbe Could you please check if I put the label description in the right place? Honestly, I am not sure about it.