Comments (2)
NixOS/nixpkgs#270696 (comment)
this is an example of a contribution that the contributor didn't know the right place to put it and would have benefited from a high level view of where stuff goes. i believe we have one but it's not in the path where we look for things as contributors.
from nix.dev.
I think these are two issues:
- Sort the various documentation types into their places (editorial)
- Make a unified presentation (technical)
It seems the @NixOS/documentation-team has mostly figured out where to put what generally:
- Reference documentation (including examples): in the source as far as possible, rendered in reference manuals
- Contribution guides: in-tree, close to the source
- Design documentation: in the source
- User guides: nix.dev
- Tutorials: nix.dev
There are still not enough places where the principle and rationale is written down or linked to help contributors figure it out by themselves. It's made worse that all of that is still implemented only to a small degree, making it almost impossible to infer from context whether something fits in. Also we sometimes seem to be struggling with determining what's what for a given PR, which probably cannot be solved by writing more things down because it very much depends on the situation.
from nix.dev.
Related Issues (20)
- Navigation doesn't keep track of your position in the hierarchy HOT 1
- Trying to fix reproducible paths section and it's not working out HOT 1
- Package versions do not match across tutorials HOT 1
- Git shell hook breaks if not a Git repo
- Overview of pinning techniques
- Guides and Recipes overview HOT 3
- Concepts overview
- Guide for writing guides
- Overview of common expression patterns HOT 2
- Sidebar Navigation Leads to Incorrect URL and Generic Anchor IDs in 'Working with Local Files'
- Linkcheck failing for raspberrypi domain
- Add a section to for a NixOS graphical configuration in the VM tutorial HOT 1
- CI stuck HOT 2
- Link does not go where expected HOT 2
- use an open service on /tutorials/module-system/module-system.html HOT 6
- Expand and Improve Module Article HOT 5
- Missing `rec-expression` anchor redirect and inquiry into redirect logic
- Issue on page /tutorials/first-steps/declarative-shell.html | Setting environment variables HOT 1
- Issue on page /tutorials/packaging-existing-software.html
- Documentation for nix.conf HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from nix.dev.