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.

Sign up for GitHub

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

Jump to bottom

Create documentation guidelines #455

Open
dgn opened this issue Oct 28, 2024 · 0 comments
Open

Create documentation guidelines #455

dgn opened this issue Oct 28, 2024 · 0 comments
Labels
enhancement New feature or request
Milestone
v1.0

Comments

@dgn
Copy link
Collaborator

dgn commented Oct 28, 2024

Let's write down some basic rules on what we think documentation should look like. Should include rules on

  • inlining vs. linking of examples
  • formatting
  • nomenclature
  • file structure
  • ...
@dgn dgn added the enhancement New feature or request label Oct 28, 2024
@dgn dgn added this to the v1.0 milestone Oct 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
v1.0
Development

No branches or pull requests
1 participant
@dgn