GithubHelp home page GithubHelp logo

Comments (2)

lf- avatar lf- commented on June 10, 2024

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.

fricklerhandwerk avatar fricklerhandwerk commented on June 10, 2024

I think these are two issues:

  1. Sort the various documentation types into their places (editorial)
  2. 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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.