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

feat: Documentation improvements #1365

Merged
merged 18 commits into from
Aug 12, 2024
Merged

feat: Documentation improvements #1365

merged 18 commits into from
Aug 12, 2024

Conversation

k3yss
Copy link
Collaborator

@k3yss k3yss commented Aug 7, 2024

This PR improves the UX with the current documentation of devenv.sh, this PR does:

  • Separate out the documentation into languages, services, processes-managers and integrations(todo)
  • Give the ability to define custom documentation on top of the references by editing the documentation files under docs/individual-docs

resolves #674

Copy link

cloudflare-workers-and-pages bot commented Aug 7, 2024

Deploying devenv with  Cloudflare Pages  Cloudflare Pages

Latest commit: bbefd79
Status: ✅  Deploy successful!
Preview URL: https://e983c585.devenv.pages.dev
Branch Preview URL: https://work-keys-doc-improvement.devenv.pages.dev

View logs

Copy link
Member

@sandydoo sandydoo left a comment

Choose a reason for hiding this comment

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

👍 Let's fix the CI bits and we should be good to go.

.github/workflows/generate.yml Outdated Show resolved Hide resolved
devenv.nix Outdated Show resolved Hide resolved
devenv.nix Outdated Show resolved Hide resolved
.github/workflows/generate.yml Outdated Show resolved Hide resolved
devenv.nix Outdated Show resolved Hide resolved
flake.nix Outdated Show resolved Hide resolved
flake.nix Outdated
Comment on lines 117 to 120
pkgs.stdenv.mkDerivation {
name = "generate-individual-docs";
src = ./.;
buildPhase = ''
Copy link
Member

Choose a reason for hiding this comment

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

Not really important, just suggestions:

  1. runCommand is a common helper for derivations like these.
  2. If you don't need the entire source, you can set src = ./docs to avoid copying the entire source to the store.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I tried using runCommand and I don't think it handles the src attributes gracefully:

https://discourse.nixos.org/t/using-the-src-attribute-in-runcommand/19329

@domenkozar domenkozar merged commit 151db4a into main Aug 12, 2024
19 of 20 checks passed
@k3yss k3yss deleted the work/keys/doc-improvement branch August 12, 2024 16:52
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.

Documentation improvement suggestions
3 participants