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

treewide: general cleanup in docs and contribution exp. #591

Merged
merged 14 commits into from
Feb 6, 2025
Merged

Conversation

NotAShelf
Copy link
Owner

@NotAShelf NotAShelf commented Jan 28, 2025

Touches up documentation for the purpose of a general cleanup (language, examples, etc.) and mentions somewhat obscure tips and tricks/features in project synopsis (README) and the manual, such as the manpages for offline documentation.

  • Mention obscure features
  • PR Template improvements
  • Flake Templates
    • Standalone Template
    • NixOS Template
    • Home-Manager Template
    • Nix-Darwin Template (?)
    • Add README files with documentation to each template
  • Refer to documentation in sections that require further elaboration
  • Fix docs-html-wrapped package for easy documentation viewing.

github-actions bot pushed a commit that referenced this pull request Jan 28, 2025
Copy link

github-actions bot commented Jan 28, 2025

🚀 Live preview deployed from 90943ff

View it here:

Debug Information

Triggered by: NotAShelf

HEAD at: docs-touchup

Reruns: 171

github-actions bot pushed a commit that referenced this pull request Feb 3, 2025
@NotAShelf NotAShelf marked this pull request as ready for review February 3, 2025 19:03
@NotAShelf NotAShelf merged commit 90943ff into main Feb 6, 2025
14 checks passed
Copy link

github-actions bot commented Feb 6, 2025

✅ Preview has been deleted successfully!

github-actions bot pushed a commit that referenced this pull request Feb 6, 2025
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.

1 participant