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

Add a fuel.nix mdbook #61

Merged
merged 20 commits into from
Jun 2, 2023
Merged

Add a fuel.nix mdbook #61

merged 20 commits into from
Jun 2, 2023

Commits on Jun 2, 2023

  1. Add a fuel.nix mdbook 

    This adds a new `book/` directory containing an mdbook for `fuel.nix`.

The new book will replace the README with a much friendlier "Quick
Start", and a more searchablei and detailed guide covering how to
install Nix, use fuel packages, and how to contribute to fuel.nix
itself.

TODO
----

- [x] Add a new "Quick Start" section with the new two-step installation approach.
- [x] Merge existing README content into subchapters.
- [x] Add a more detailed "Nix Setup" chapter for those interested in more details.
- [x] Add a section on `nix profile install` for persistent installation to the "Packages" chapter.
- [ ] Add a new "Contributing" section with details on how to add/update packages and milestones.
- [ ] Update the README to simply point to the book and Quick Start.
- [ ] Add a CI step to publish the book.
- [ ] Open an issue to remove the **NOTE:** under the `nix profile install` section required due to DeterminateSystems/nix-installer#477.
    @mitchmindtree
    mitchmindtree committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    ecb4916 View commit details
    Browse the repository at this point in the history

  2. Remove old layout stub files

    @mitchmindtree
    mitchmindtree committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    df12db4 View commit details
    Browse the repository at this point in the history

  3. Begin work on the Contributing/Internals chapter

    @mitchmindtree
    mitchmindtree committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    bf2a732 View commit details
    Browse the repository at this point in the history

  4. Add internals chapter with sections on manifests, packages, milestones

    @mitchmindtree
    mitchmindtree committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    ff2eea9 View commit details
    Browse the repository at this point in the history

  5. Complete the Adding Packages and Updating Packages chapters

    @mitchmindtree
    mitchmindtree committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    715bf1f View commit details
    Browse the repository at this point in the history

  6. Update the adding-packages section with more links

    @mitchmindtree
    mitchmindtree committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    fd3b8a4 View commit details
    Browse the repository at this point in the history

  7. Update the README to link to the book and the Quick Start

    @mitchmindtree
    mitchmindtree committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    0d2b0f3 View commit details
    Browse the repository at this point in the history

  8. Update the nix profile note with latest info on issue

    @mitchmindtree
    mitchmindtree committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    1446115 View commit details
    Browse the repository at this point in the history

  9. Add a book-dev devShell providing mdbook. Check book build in CI.

    @mitchmindtree
    mitchmindtree committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    a377bb8 View commit details
    Browse the repository at this point in the history

  10. Update CI workflow name to ci

    @mitchmindtree
    mitchmindtree committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    c96b21c View commit details
    Browse the repository at this point in the history

  11. Add a publish-book workflow that publishes the book on master commits

    @mitchmindtree
    mitchmindtree committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    2ef445e View commit details
    Browse the repository at this point in the history

  12. Tweaks to the README formatting, links

    @mitchmindtree
    mitchmindtree committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    ffead96 View commit details
    Browse the repository at this point in the history

  13. Add a note about milestone builds under CI

    @mitchmindtree
    mitchmindtree committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    290d9ed View commit details
    Browse the repository at this point in the history

  14. Fix vscode plugin link

    @mitchmindtree
    mitchmindtree committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    f89fac3 View commit details
    Browse the repository at this point in the history

  15. Fix version demonstration command in packages chapter

    @mitchmindtree
    mitchmindtree committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    87d7263 View commit details
    Browse the repository at this point in the history

  16. Don't fail fast on error so we can see all errors

    @mitchmindtree
    mitchmindtree committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    2ed4c02 View commit details
    Browse the repository at this point in the history

  17. Move devshells, overlays and editor-plugins into new power-users chapter

    @mitchmindtree
    mitchmindtree committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    28d0b85 View commit details
    Browse the repository at this point in the history

  18. Add a tip on selecting commits for new milestones

    @mitchmindtree
    mitchmindtree committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    cdc8ee0 View commit details
    Browse the repository at this point in the history

  19. Add a chapter on updating flake inputs

    @mitchmindtree
    mitchmindtree committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    97ca174 View commit details
    Browse the repository at this point in the history

  20. Add a tip about checking upstream CI when adding new package patches

    @mitchmindtree
    mitchmindtree committed Jun 2, 2023
    Configuration menu
    Copy the full SHA
    0883c00 View commit details
    Browse the repository at this point in the history