-
Notifications
You must be signed in to change notification settings - Fork 124
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
Update placement of Onboarding doc to be more prominent #2071
Comments
I want to work on this issue. I want to understand how can I get started, can you please explain how can I move this content of Onboarding Bootcamp section to the top. As much as I've understood this repository is a good project which uses Markdown syntax and extends it making it feature rich compilation to HTML, which is impressive. I am very keen to work in open source. Thank you |
Hi @charandeepsinghb , that's great! To get started, you should take a look at our developer docs (https://markbind.org/devdocs/devGuide/devGuide.html) and the onboarding documentation first. In particular, knowing how to setup, update and serve a markbind site is good enough. This issue involves editing the site-nav component, so you may want to take a look at this too: https://markbind.org/userGuide/components/navigation.html#site-navigation-menus. You only need to update the file located at Let me know if you still run into any issues with this task. Looking forward to receiving your PR! :) |
@raysonkoh I've created the PR forget to add you as a reviewer (I'm new to this, sorry). I've understood a bit about how things work in this from the documentation and guidelines that are needed to be followed. Thank you. Here is the PR link #2086 |
I personally would prefer for the on-boarding bootcamp to not be at the top, since developers would use it only once. I think 90% of the time, developers would not be looking for the bootcamp and it would be taking up the valuable real estate at the top of the page 😅 If we move it to the top, maybe we could have it un-expanded (so new developers can still find it easily, and it wouldn't take up too much space)? Or we could add a more prominent link on the landing page to lead developers to the Onboarding Bootcamp? |
I think either way works! I'm leaning slightly towards the first suggestion for the reason that you listed. @charandeepsinghb thanks for the PR! Following the discussion above, could you make a slight change to your PR so that the onboarding section is collapsed instead of expanded? |
Sure, I will update the PR with onboarding section collapsed instead of expanded. |
Updated te PR for
|
Hi, So what's the next progress of the PR. (Newbie 😅) |
Hey @charandeepsinghb, I have merged your PR 🥳 . Feel free to work on other issues! |
Currently, the onboarding doc is placed at the bottom of the site-nav (ss below).
I suggest moving it right below the "Contributing" section to be more prominent and visible for potentially new contributors.
The relevant file is at
docs/_markbind/layouts/devGuide.md
.The text was updated successfully, but these errors were encountered: