Skip to content

Create documentation guidelines #455

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

Open
dgn opened this issue Oct 28, 2024 · 1 comment
Open

Create documentation guidelines #455

dgn opened this issue Oct 28, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

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
@fjglira fjglira added the documentation Improvements or additions to documentation label Feb 4, 2025
@fjglira fjglira self-assigned this Mar 3, 2025
@fjglira
Copy link
Contributor

fjglira commented Mar 3, 2025

Assign to me because it is related to #454, and to be able to set the rules for the automatic script to run the test, we will need these guides

@dgn dgn modified the milestones: v1.0, v1.1 Mar 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants