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

[Documentation]: Wiki QOL suggestions #1589

Open
1 task done
ficcdaf opened this issue Oct 5, 2024 · 0 comments
Open
1 task done

[Documentation]: Wiki QOL suggestions #1589

ficcdaf opened this issue Oct 5, 2024 · 0 comments
Labels
feature Issues related to feature proposals. Please attach a module.

Comments

@ficcdaf
Copy link

ficcdaf commented Oct 5, 2024

Issues

  • I have checked existing issues and there are no existing ones with the same request.

Feature description

As it stands, navigating the wiki is a bit of a challenge. The Inbuilt Modules category is overall a bit misleading, because it may lead a new user to believe these modules are included OOTB, when in-fact they need to be specified in the neorg configuration. The modules are clearly classified on the wiki index page, but from my experience browsing the wiki as a new user, I often forgot about this page and found myself confusedly trying to understand the Inbuilt Modules in the sidebar. My proposed changes:

  • Add a link to the wiki index/homepage called Home to the wiki sidebar
  • Split the Inbuilt Modules sidebar dropdown into the Default, Other, and Developer categories like on the homepage.
  • Have the core.defaults module list all of its child modules

I think these small changes would make the wiki much more welcoming for new users. Please let me know what you guys think.

Help

Yes

Implementation help

No response

@ficcdaf ficcdaf added the feature Issues related to feature proposals. Please attach a module. label Oct 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature Issues related to feature proposals. Please attach a module.
Projects
None yet
Development

No branches or pull requests

1 participant