Skip to content
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

Closed
wants to merge 1 commit into from

Conversation

wiksien
Copy link
Contributor

@wiksien wiksien commented Jul 10, 2022

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.

@netlify
Copy link

netlify bot commented Jul 10, 2022

Deploy Preview for redwoodjs-docs ready!

Name Link
🔨 Latest commit 2b83815
🔍 Latest deploy log https://app.netlify.com/sites/redwoodjs-docs/deploys/62ca198ff52321000988b1b1
😎 Deploy Preview https://deploy-preview-5895--redwoodjs-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Copy link
Contributor

@jtoar jtoar left a 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):

image

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
Copy link
Contributor

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',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't quite what we want cause it changes the label of the version:

image

@jtoar jtoar added the release:docs This PR only updates docs label Jul 11, 2022
@wiksien
Copy link
Contributor Author

wiksien commented Jul 11, 2022

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!

@jtoar
Copy link
Contributor

jtoar commented Jul 11, 2022

@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.

@wiksien
Copy link
Contributor Author

wiksien commented Jul 11, 2022

@jtoar Sure thing! Please do recommend me a one.

@jtoar
Copy link
Contributor

jtoar commented Jul 25, 2022

@wiksien sorry for the late response, I think this one may be a good one to get started with: #343.

I'll close this PR for now but let me know if you feel up to digging into that one and I'm happy to help review or provide guidance.

@jtoar jtoar closed this Jul 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release:docs This PR only updates docs
Projects
Status: Archived
Development

Successfully merging this pull request may close these issues.

3 participants