Comments (1)
I propose the following sequence of steps:
-
Pull out the Nixpkgs and NixOS manuals out of nixos.org into nix.dev at all
I had started this, but I have lots of higher priorities, so it won't happen in the next weeks. I can share my crufty local branch if anyone is interested in picking it up.
-
Add consistent-looking style sheets to each of the manuals.
I was playing with the idea of doing it upstream, but this may need discussion.
Advantages:
- Building locally will give you the same result as you'd observe hosted online. Currently this is only the case for the Nix manual, for the reason that there is no styling applied whatsoever.
- Allows working on style issues independently, since the build setups differ for the current three officially documented projects. There may be more in the future, and keeping those custom information downstream will likely add friction.
Disadvantages:
- Duplicates some styling code across projects, with a risk of going out of sync
- Requires backporting the style additions to all actively supported versions.
Side note: I'm really not a fan of mdBook, it's not very mature compared to e.g. Sphinx. And while that sort of works, I'm not a big fan of Sphinx either. All these static site systems are too simple-minded for our use cases and need hacks and customisation. And highly bespoke usage is really problematic because it tends to be brittle and undocumented, but we need our docs infrastructure to be both powerful and low-tech while meshing with the Git/GitHub workflow.
By low-tech I mean:
-
Commonplace
Example: CSS instead of some specialist frameworks
-
Straightforward handling
If you need editor integration to make meaningful contributions, it's too hard to use
-
Small stack
Learning multiple technologies to be able to manipulate the setup is too much of a barrier. We already impose Nix, Git, Markdown, and all sorts of other random things on contributors.
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.