Skip to content

Improve the documentation for new users #575

Description

@qdeslandes

The project's documentation (bpfilter.io) evolved based on the source code documentation, and contributors-maintained guides. It lacks structure and examples for new users to easily use bpfilter. Re-organizing the documentation to provide a clear learning path for new users would be very beneficial to the project.

Diátaxis seems to be widely used as a documentation framework and would be worth looking into.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: documentationDocumentation, and documentation generation

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions