Rename docs to guides, and group similar guides

joshk commented 10 months ago

I totally understand if this PR is going too far and isn't seen as a good addition.

I took some learnings from how Livebook and Liveview structure their extra pages and applied them to the Nerves project.

This PR:

uses the naming of Guides in the top of the sidebar
moves the pages from docs to guides (in the repo)
adds group sections of Introduction, Core, and Advanced
simplified a bunch of titles in various guides so they display better in the sidebar
removed the 'Is something wrong?` section at the bottom of all guides, these weren't formatted correctly and seemed redundant.
updated all guide filenames to not use spaces

This is a screenshot of what the sidebar now looks like:

joshk commented 10 months ago

Thanks for your feedback @mnishiguchi :)

I also struggled with Core but thought it would be a good first change.

joshk commented 10 months ago

(just forced pushed a little change to my PR where I noticed that I had Examples projects instead of Example projects)

joshk commented 10 months ago

Hi @jjcarstens, do you have any feedback on this PR?

jjcarstens commented 10 months ago

Sorry I'm so delayed. I'm looking at this now and may have a few thoughts shortly

fhunleth commented 10 months ago

This is looking great! Thank you.

joshk commented 10 months ago

Thanks for the feedback @jjcarstens, I can create another PR for the Usage change, and to incorporate some of the ideas in #926

Thanks for approving these changes and merging in the PR.

nerves-project / nerves