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.

Sign up for GitHub

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

Jump to bottom

docs: switch to mdbook #471

Merged
merged 12 commits into from
Aug 7, 2023
Merged

docs: switch to mdbook #471

merged 12 commits into from
Aug 7, 2023

Conversation

Wolbyte
Copy link
Contributor

@Wolbyte Wolbyte commented Jul 4, 2023 •
edited
Loading

Description

The aim of this pull request is to address the goals mentioned in #114 + some general improvements in the overall generation of the documentation, using mdBook as the new back-end for generation.

Any feedback is appreciated.

TODO

  • Switch to mdbook for generation.
  • Add support for nix highlighting.
  • Make the option declarations point to the project's GitHub page.
  • Per module documentation.
  • Separate each extra component (such as extensions) into its sub-section.
  • Add CONTRIBUTING.md to the book.
  • Use nix highlighting in the documentation.
    Add Introduction to the book.
    Add (possibly automated) default index.md files for each section

@Wolbyte Wolbyte changed the title docs: mdbook init docs: switch to mdbook Jul 4, 2023
@Wolbyte Wolbyte changed the title docs: switch to mdbook docs: switch to mdbook (WIP) Jul 4, 2023
@GaetanLepage GaetanLepage self-requested a review July 4, 2023 14:49
@Wolbyte Wolbyte force-pushed the per-module-docs branch from ddf967d to 138ba03 Compare July 6, 2023 21:46
@Wolbyte Wolbyte changed the title docs: switch to mdbook (WIP) docs: switch to mdbook Aug 6, 2023
@Wolbyte Wolbyte marked this pull request as ready for review August 6, 2023 20:37
GaetanLepage
GaetanLepage approved these changes Aug 7, 2023
View reviewed changes
Copy link
Member

@GaetanLepage GaetanLepage left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing work !
This will for sure help our users :)

@GaetanLepage GaetanLepage requested a review from traxys August 7, 2023 07:50
@Wolbyte
docs: fix contributing separator
a448467 
docs: fix missing submodules docs
traxys
traxys approved these changes Aug 7, 2023
View reviewed changes
Copy link
Member

@traxys traxys left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really cool work!

@GaetanLepage GaetanLepage merged commit ecd5933 into nix-community:main Aug 7, 2023
@Wolbyte Wolbyte mentioned this pull request Aug 8, 2023
Merged
@Wolbyte Wolbyte deleted the per-module-docs branch August 19, 2023 11:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GaetanLepage GaetanLepage GaetanLepage approved these changes

@traxys traxys traxys approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Wolbyte @traxys @GaetanLepage