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

support "Edit this page" in docs #218

Closed
juzhiyuan opened this issue Mar 1, 2021 · 12 comments · Fixed by #235
Closed

support "Edit this page" in docs #218

juzhiyuan opened this issue Mar 1, 2021 · 12 comments · Fixed by #235
Assignees
Labels
good first issue Good for newcomers

Comments

@juzhiyuan
Copy link
Member

Hi, I noticed that on our website, we don't have an Edit this page link, it's useful for visitors to submit feedbacks like a typo fix, etc.

We could check https://v2.docusaurus.io/docs/ first to see if it supports this feature.

@juzhiyuan juzhiyuan added the good first issue Good for newcomers label Mar 1, 2021
@akshitadixit
Copy link

Hello may I work on this?

@juzhiyuan
Copy link
Member Author

Of course!

@akshitadixit
Copy link

@juzhiyuan please clarify a few things since I'm relatively new with things here:

  1. Do you require a button on the homepage only?
  2. Do you require a link in someplace like the footer?
  3. Do you require the edit option on every docs page?

Also it would be really great of you if you could guide me about the exact file I will need to make the changes to, pardon me for such a basic question and I understand that you might have other engagements. Kindly overlook if this sounds too naive.

@juzhiyuan
Copy link
Member Author

Hello! @qier222 will guide you when he's free :)

@akshitadixit
Copy link

Sure

@qier222
Copy link
Contributor

qier222 commented Mar 3, 2021

I prefer to add "Edit this page" on every docs page, just like docusaurus.

@juzhiyuan
Copy link
Member Author

ok, @akshitadixit, could you please have a Google search about Edit this page in docusaurus first?

@qier222
Copy link
Contributor

qier222 commented Mar 3, 2021

https://v2.docusaurus.io/docs/next/api/plugins/@docusaurus/plugin-content-docs

@akshitadixit
Copy link

@qier222 @juzhiyuan I am extremely sorry about taking up your time, but this is currently advanced for a beginner like me. I'm afraid I cannot solve this issue.

@qier222
Copy link
Contributor

qier222 commented Mar 3, 2021

@qier222 @juzhiyuan I am extremely sorry about taking up your time, but this is currently advanced for a beginner like me. I'm afraid I cannot solve this issue.

It's ok

@juzhiyuan
Copy link
Member Author

image

Does this mean if we add this URL on every doc file, then that page will have an Edit this page link?

@qier222
Copy link
Contributor

qier222 commented Mar 3, 2021

check out this pr
#235

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants