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

Add more docs #171

Merged
merged 9 commits into from
Jul 4, 2023
Merged

Add more docs #171

merged 9 commits into from
Jul 4, 2023

Conversation

woile
Copy link
Contributor

@woile woile commented Jun 15, 2023

This PR adds the following:

  • an examples folder
  • an example for devShell
  • templates are no longer marked as examples, now there are templates and examples avoiding confusion

#170

Copy link
Member

@roberth roberth left a comment

Choose a reason for hiding this comment

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

Made a couple suggestions, but overall a good example.
I'll try to be quicker next time.

README.md Show resolved Hide resolved
examples/shell-environments/README.md Outdated Show resolved Hide resolved
examples/shell-environments/flake.nix Outdated Show resolved Hide resolved
examples/shell-environments/flake.nix Outdated Show resolved Hide resolved
examples/shell-environments/flake.nix Outdated Show resolved Hide resolved
modules/devShells.nix Outdated Show resolved Hide resolved
@woile
Copy link
Contributor Author

woile commented Jun 22, 2023

Thanks for all the awesome feedback, I've updated the PR!

@woile
Copy link
Contributor Author

woile commented Jun 23, 2023

Added another very easy example with mission-control.

examples/shell-environments/README.md Outdated Show resolved Hide resolved
examples/project-commands/README.md Outdated Show resolved Hide resolved
examples/shell-environments/README.md Outdated Show resolved Hide resolved
examples/project-commands/README.md Outdated Show resolved Hide resolved
examples/project-commands/flake.nix Show resolved Hide resolved
examples/shell-environments/README.md Outdated Show resolved Hide resolved
examples/shell-environments/README.md Outdated Show resolved Hide resolved
examples/project-commands/README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
examples/project-commands/README.md Outdated Show resolved Hide resolved
modules/devShells.nix Outdated Show resolved Hide resolved
examples/shell-environments/README.md Outdated Show resolved Hide resolved
@woile
Copy link
Contributor Author

woile commented Jun 30, 2023

Everything updated 🚀

examples/shell-environments/README.md Outdated Show resolved Hide resolved
@roberth
Copy link
Member

roberth commented Jul 4, 2023

bors r+

@bors
Copy link
Contributor

bors bot commented Jul 4, 2023

Build succeeded!

The publicly hosted instance of bors-ng is deprecated and will go away soon.

If you want to self-host your own instance, instructions are here.
For more help, visit the forum.

If you want to switch to GitHub's built-in merge queue, visit their help page.

@bors bors bot merged commit 8e8d955 into hercules-ci:main Jul 4, 2023
@roberth
Copy link
Member

roberth commented Jul 4, 2023

Thank you @woile!

@woile
Copy link
Contributor Author

woile commented Jul 4, 2023

No problem, I'll send more PR's as I come up with working snippets, and I'll try to add more tutorials to the website. Any idea if it's possible to show snippets from the examples/ folder into the website? I want to use mdbook snippets but there are 2 different repos.

@roberth
Copy link
Member

roberth commented Jul 4, 2023

We could change flake.parts-website to copy them in using the flake-parts flake input's outPath ie cp -r ${inputs.flake-parts}/examples ./somewhere.
It auto updates twice a day and you can use nix build --override-input flake-parts ./flake-parts ./flake.parts-website to build locally.

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.

4 participants