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

Create "Nimble Guide" #1190

Merged
merged 6 commits into from
Mar 20, 2024
Merged

Create "Nimble Guide" #1190

merged 6 commits into from
Mar 20, 2024

Conversation

narimiran
Copy link
Member

@narimiran narimiran commented Mar 5, 2024

This is a large PR, so here is a TL;DR — instead of having the documentation in the (very large) readme, it is separated into a proper multi-page documentation, with a working search, etc etc.

You can see how it looks here: https://narimiran.github.io/nimble/ https://nim-lang.github.io/nimble/

The documentation is, roughly, divided into three sections (see the menu at the top of the index page):

  • using existing packages
  • creating a new package
  • how to use the new nimble develop workflow

IMO, the content itself can (and should) be improved once this is merged, so others can contribute.


UPDATE: Ready for merging.

This is NOT READY for merging. The following steps are needed before it should be merged:

  1. The admin should go to the repo settings and under 'pages' tab enable gh-pages, see the pic below on how it should look: Done.
    img

  2. Once this is done (please ping me), I need to make another commit, changing the remote repo from my fork to this repo in the Makefile and changing the links in readme. Done.

@narimiran narimiran merged commit 0f2ac3f into nim-lang:master Mar 20, 2024
3 checks passed
jmgomez pushed a commit to jmgomez/nimble that referenced this pull request Mar 20, 2024
@narimiran narimiran deleted the mkdocs branch April 17, 2024 07:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant