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

Improve the structure of the mdBook documentation #10619

Conversation

David-Else
Copy link
Contributor

(This is a follow up to #5534)

The current documentation does not have a consistent structure making it hard to see an overview of the content and navigate to the desired section. Currently:

1. Installation is totally self-contained with no mdBook subsections. All navigation is in the TOC.

2. Usage has some usage guides in the markdown file TOC, and also some in mdBook subsections.

3. Migrating from Vim is not complete and basically just a link to the WIKI < deal with that another day

4. Config has the Editor subsection in the markdown file (no TOC), and then the rest in mdBook subsections.

5. Guides is the only consistent one. A brief description of the section, and then all neatly divided into mdBook subsections.

I have refactored it to be consistent and follow the following format, the same as the current Guides section:

x Section Name

  Contains overview of the section, or important info that does not merit a subsection

    x.x Subsection Name

      Contains the content

I have not changed any of the actual content, apart from in keymap, the heading should be an h2 for consistency, and - [Comment mode](#comment-mode) was a bug/broken link, the content never was created.

@David-Else
Copy link
Contributor Author

David-Else commented May 2, 2024

@the-mikedavis Can I request a review from you? I can't seem to find how to do it in the Github web interface, cheers.

Here is how it looks now:

image

@the-mikedavis the-mikedavis self-requested a review May 2, 2024 13:35
@the-mikedavis the-mikedavis added the A-documentation Area: Documentation improvements label May 2, 2024
@pascalkuthe pascalkuthe merged commit a959c0e into helix-editor:master May 6, 2024
6 checks passed
@David-Else David-Else deleted the Improve-the-structure-of-the-documentation branch May 6, 2024 15:44
Vulpesx pushed a commit to Vulpesx/helix that referenced this pull request Jun 7, 2024
Chirikumbrah pushed a commit to Chirikumbrah/helix that referenced this pull request Jun 15, 2024
smortime pushed a commit to smortime/helix that referenced this pull request Jul 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documentation Area: Documentation improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants