Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A description of the rules is missing from the documentation #786

Open
ClemensLinnhoff opened this issue Mar 7, 2024 · 1 comment
Open
Assignees
Labels
Documentation Everything which impacts the quality of the documentation and guidelines.
Milestone

Comments

@ClemensLinnhoff
Copy link
Contributor

Describe the bug

While rules are part of the specification, I could not find any description explaining what the rules mean and how they work in the documentation.

Describe the expected behavior

A dedicated page to explain the rules is needed.

@ClemensLinnhoff ClemensLinnhoff self-assigned this Mar 7, 2024
@ClemensLinnhoff ClemensLinnhoff added the Documentation Everything which impacts the quality of the documentation and guidelines. label Mar 7, 2024
@ClemensLinnhoff ClemensLinnhoff added this to the V3.8.0 milestone May 10, 2024
@ClemensLinnhoff
Copy link
Contributor Author

The rules are briefly mentioned in the contributing section. But still without any description about the rules itself.

There should be a dedicated page about the rules in the main section of the OSI spec, which is linked in the contributing page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Everything which impacts the quality of the documentation and guidelines.
Projects
None yet
Development

No branches or pull requests

2 participants