Comments (1)
For software libraries, and apis, I've seen drop-down's to choose major versions that effectively support people working with different versions.
That's fine for single "things" that have specific versions, and a documentation release to go with that version. But the Raspberry Pi documentation isn't around a single piece of software or hardware. It isn't necessarily versioned. OS releases can sometimes make major changes to the documentation, but there are other factors like hardware releases, or the introduction of entirely new classes of product, that change things more fundamentally.
Documentation is not on a per-model basis. It never has been. These days it would be hard to really define what "a model" is when we now have multiple core product lines.
As a consequence we would have to maintain multiple versions (snapshots) of the documentation site, and I don't see that reducing support burden. Especially as these snapshots would be taken at more or less arbitrary places, with documentation for some products okay, while for others the documentation wouldn't be in a good state. It's really unclear to me what would spawn a new snapshot of the site that had to be maintained, versus a change (or set of changes) that wouldn't.
Right now if you want a previous revision of the documentation site you can check it out from Github, and build the site locally. As many users would find that difficult I'm currently toying with methods to automate that, and let users do it inside Github Codespaces, so that they could revert to previous versions of the site automagically, and have it all "just work" in the browser.
Right now effort is going towards rewriting the current documentation (aka Project Rewrite) around the idea that there is more than one core product β most of the mess is there because we had a single product and the design of the documentation is around supporting that and only that β in a more narrative style, with a better split between feature and task-led documentation.
Alongside this we have developer effort is currently directed towards our PDF toolchain which needs overhauled due to technical debt building up, and some fragility introduced by third-party dependencies. After that ships there are other things already on the schedule.
Then maybe after that, we can think about archival revisions. Sorry.
from documentation.
Related Issues (20)
- Update power supply section HOT 1
- SPI bus section needs updating for Pi 5 HOT 3
- Add info on Device Tree files for CM4 HOT 2
- Diagram doc error - says SRAM instead of SDRAM HOT 2
- Explanation of LED behaviour on different models of Pi HOT 2
- No documentation on disabling HDMI audio using config.txt file.
- Best practice for revision code usage HOT 1
- Markdown
- Markdown
- Python Build Hat for Ubuntu 22 HOT 1
- raspberry pi usb port HOT 1
- Partially fixed by #3284 HOT 3
- rpi-eeprom-update βThis tool only works with a Raspberry Pi 4" HOT 1
- VNC instructions are outdated HOT 4
- how to use open media NAS HOT 1
- Document power draw of the official case fan and the active cooling fan HOT 3
- Datasheet for ML2020 RTC battery for Pi5 is missing HOT 6
- Device specific private key is now supported for 2712 HOT 4
- document disabled "GPU" features when setting gpu_mem <64 MiB HOT 2
- Make the `$ ` at the beginning of interactive code/console snippets uncopyable. HOT 4
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 documentation.