Hi,
In https://www.kernel.org/doc/html/v6.2/ Table of Contents consisted
of 10 items. It was compact, organized and observable:
The Linux Kernel documentation
- Working with the development community
- Internal API manuals
- Development tools and processes
- User-oriented documentation
- Firmware-related documentation
- Architecture-specific documentation
- Other documentation
- Translations
Indices and tables
Since https://www.kernel.org/doc/html/v6.3/ it consists of 60+ items.
Now it is long, unorganized and unobservable:
A guide to the Kernel Development Process
Submitting patches: the essential guide to getting your code into the kernel
Code of conduct
Kernel Maintainer Handbook
All development-process docs
Linux kernel licensing rules
HOWTO do Linux kernel development
Contributor Covenant Code of Conduct
Linux Kernel Contributor Covenant Code of Conduct Interpretation
A guide to the Kernel Development Process
Submitting patches: the essential guide to getting your code into the kernel
Handling regressions
Programming Language
Linux kernel coding style
Subsystem and maintainer tree specific development process notes
Kernel Maintainer PGP guide
Email clients info for Linux
Linux Kernel Enforcement Statement
Kernel Driver Statement
Security bugs
Embargoed hardware issues
Minimal requirements to compile the Kernel
The Linux Kernel Driver Interface
Linux kernel management style
Everything you ever wanted to know about Linux -stable releases
Linux Kernel patch submission checklist
Index of Further Kernel Documentation
Deprecated Interfaces, Language Features, Attributes, and Conventions
List of maintainers and how to submit kernel changes
Researcher Guidelines
Applying Patches To The Linux Kernel
Adding a New System Call
Linux magic numbers
Why the “volatile” type class should not be used
(How to avoid) Botching up ioctls
clang-format
arch/riscv maintenance guidelines for developers
Unaligned Memory Accesses
Core API Documentation
Driver implementer’s API guide
Kernel subsystem documentation
Locking in the kernel
Linux kernel licensing rules
How to write kernel documentation
Development tools for the kernel
Kernel Testing Guide
Kernel Hacking Guides
Linux Tracing Technologies
fault-injection
Kernel Livepatching
Rust
The Linux kernel user’s and administrator’s guide
The kernel build system
Reporting issues
User-space tools
The Linux kernel user-space API guide
The Linux kernel firmware guide
Open Firmware and Devicetree
CPU Architectures
Unsorted Documentation
Questions:
- Why?
- What are further plans?
- What to do?
Thanks,
Costa
Costa Shulyupin <[email protected]> writes:
> Hi,
>
> In https://www.kernel.org/doc/html/v6.2/ Table of Contents consisted
> of 10 items. It was compact, organized and observable:
>
> The Linux Kernel documentation
> - Working with the development community
> - Internal API manuals
> - Development tools and processes
> - User-oriented documentation
> - Firmware-related documentation
> - Architecture-specific documentation
> - Other documentation
> - Translations
> Indices and tables
>
> Since https://www.kernel.org/doc/html/v6.3/ it consists of 60+ items.
> Now it is long, unorganized and unobservable:
By "table of contents" you're talking about the left column? That was
done after I got a bunch of complaints about the alabaster sidebar. I
agree it's still far from ideal.
jon
Hi Jonathan,
> By "table of contents" you're talking about the left column?
Yes, on the left. Now it is named "Contents".
> I agree it's still far from ideal.
Do you have any prototypes as examples or in mind?
Costa,
Thank you