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

Add Docs icon navbar item and link to online docs URL #60

Closed
2 tasks done
parkview opened this issue May 23, 2021 · 5 comments · Fixed by #128
Closed
2 tasks done

Add Docs icon navbar item and link to online docs URL #60

parkview opened this issue May 23, 2021 · 5 comments · Fixed by #128
Assignees
Labels
good first issue Good for newcomers status: accepted accepted type: enhancement New feature or request

Comments

@parkview
Copy link
Collaborator

parkview commented May 23, 2021

@madeinoz67 madeinoz67 added type: documentation Improvements or additions to documentation type: enhancement New feature or request labels May 24, 2021
@madeinoz67 madeinoz67 added this to the 2001.0.0-pre-release milestone May 24, 2021
@madeinoz67 madeinoz67 added the good first issue Good for newcomers label May 24, 2021
@mohitbalwani
Copy link

Hey I would like to work on this issue !
I am pretty new to this so how do you want me to contribute?

@madeinoz67
Copy link
Owner

madeinoz67 commented May 25, 2021

awesome @mohitbalwani a PR will be fine.

I've been pushing quite a few changes so just make sure you keep you your master synced.

As per our CONTIBUTION doc, branch from your fork master and dev on there, and submit the branch with changes as your PR

@madeinoz67
Copy link
Owner

madeinoz67 commented May 25, 2021

with this current issue, I think it should be a new icon on the navbar called docs and then link to the current online docs: https://madeinoz67.github.io/maker-hub/

The help icon should link to the github discussions URL: https://github.com/madeinoz67/maker-hub/discussions

also see issue #75 if you're feeling adventurous

@madeinoz67 madeinoz67 changed the title Update the Help page to link to new URL Add Docs icon navbar item and link to online docs URL May 25, 2021
@madeinoz67 madeinoz67 added status: accepted accepted and removed type: documentation Improvements or additions to documentation labels May 25, 2021
@madeinoz67
Copy link
Owner

Just realised that the route '/docs' will clash with api openapi generated docs, so will need to make the static route something other than /docs

Maybe the navbar icon will route to /documentation page that lists all documentation both openapi docs and projects github mkdocs site

@jubbp
Copy link
Contributor

jubbp commented Jul 26, 2021

Any movement on this issue? Can I assist?

@madeinoz67 madeinoz67 assigned jubbp and unassigned mohitbalwani Jul 26, 2021
@madeinoz67 madeinoz67 removed this from the 2021.0.0-dev3 milestone Jul 26, 2021
@madeinoz67 madeinoz67 linked a pull request Jul 29, 2021 that will close this issue
madeinoz67 added a commit that referenced this issue Jul 29, 2021
closes #60 - Added link for Docs and updated help link
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 status: accepted accepted type: enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants