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.

Sign up for GitHub

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

Jump to bottom

[FEATURE REQUEST] Add Edit me & report issue to academy pages #14

Open
1 of 2 tasks
darigovresearch opened this issue May 8, 2021 · 1 comment
Open
1 of 2 tasks

[FEATURE REQUEST] Add Edit me & report issue to academy pages #14

darigovresearch opened this issue May 8, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@darigovresearch
Copy link
Collaborator

darigovresearch commented May 8, 2021 •
edited
Loading

Very often open source documentation uses the right hand part of the page to have for specific operations such as a "Report issue with this page" and "Edit this page. These are very helpful for beginners wanting to contribute and seasoned veterans to open source as it reduces the friction to make contributions.

Not sure if this is possible to enable this feature in Docusaurus but see below a good example of such a feature

https://docs.indexmachines.io/docs/

  • Edit page
  • Report issue with page
@darigovresearch
Copy link
Collaborator Author

Precious plastic has an edit button at the bottom of the page, it encourages people to contribute in a very easy way

image

darigovresearch added a commit to darigovresearch/fixing-fashion-academy that referenced this issue Jul 3, 2021
@darigovresearch
feat: Adds editURL to website/siteConfig.js
c4198f0 
Relevant to issue ONEARMY#14

Follows config file of the precious plastic academy site - https://github.com/ONEARMY/academy/blob/master/website/siteConfig.js
@darigovresearch darigovresearch mentioned this issue Jul 3, 2021
Merged
@darigovresearch darigovresearch added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Jul 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@darigovresearch