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

[Documentation] Improve documentation #201

Open
enridaga opened this issue Feb 4, 2022 · 5 comments
Open

[Documentation] Improve documentation #201

enridaga opened this issue Feb 4, 2022 · 5 comments
Labels
Documentation Improvements or additions to documentation

Comments

@enridaga
Copy link
Member

enridaga commented Feb 4, 2022

I'm going to use this comment to collect the general structure of the documentation and general format issues

General structure

The plan for improving the documentation is the following.
The README will be left as it is since it already gives an overview of what the tool does.
The sections that are going to be added are:

Format issues

  • Remove tables from format examples.
  • Code blocks inside table cells inside details section ... some processors seem to not like that (e.g. the one of readthedocs.org)
@enridaga enridaga self-assigned this Feb 4, 2022
@enridaga enridaga added the Documentation Improvements or additions to documentation label Feb 4, 2022
enridaga added a commit that referenced this issue Feb 4, 2022
enridaga added a commit that referenced this issue Feb 4, 2022
enridaga added a commit that referenced this issue Feb 4, 2022
@enridaga enridaga changed the title [Documentation] Remove tables from format examples [Documentation] Improve documentation Feb 4, 2022
@enridaga
Copy link
Member Author

enridaga commented Feb 4, 2022

I think we can leave this issue for any commit related to improvements in the docs

@enridaga enridaga pinned this issue Feb 4, 2022
enridaga added a commit that referenced this issue Feb 4, 2022
enridaga added a commit that referenced this issue Feb 4, 2022
enridaga added a commit that referenced this issue Feb 4, 2022
enridaga added a commit that referenced this issue Feb 4, 2022
enridaga added a commit that referenced this issue Feb 4, 2022
enridaga added a commit that referenced this issue Feb 4, 2022
enridaga added a commit that referenced this issue Feb 4, 2022
enridaga added a commit that referenced this issue Feb 4, 2022
enridaga added a commit that referenced this issue Feb 4, 2022
enridaga added a commit that referenced this issue Feb 4, 2022
enridaga added a commit that referenced this issue Feb 4, 2022
enridaga added a commit that referenced this issue Feb 4, 2022
enridaga added a commit that referenced this issue Feb 4, 2022
luigi-asprino added a commit that referenced this issue Jan 5, 2024
luigi-asprino added a commit that referenced this issue Jan 5, 2024
luigi-asprino added a commit that referenced this issue Jan 5, 2024
luigi-asprino added a commit that referenced this issue Jan 8, 2024
luigi-asprino added a commit that referenced this issue Jan 9, 2024
luigi-asprino added a commit that referenced this issue Jan 9, 2024
luigi-asprino added a commit that referenced this issue Jan 9, 2024
luigi-asprino added a commit that referenced this issue Jan 9, 2024
enridaga added a commit that referenced this issue Feb 21, 2024
enridaga added a commit that referenced this issue Feb 23, 2024
enridaga added a commit that referenced this issue Feb 23, 2024
enridaga added a commit that referenced this issue Feb 23, 2024
enridaga added a commit that referenced this issue Feb 23, 2024
enridaga added a commit that referenced this issue May 29, 2024
enridaga added a commit that referenced this issue May 29, 2024
enridaga added a commit that referenced this issue May 29, 2024
enridaga added a commit that referenced this issue May 29, 2024
enridaga added a commit that referenced this issue May 29, 2024
luigi-asprino added a commit that referenced this issue Aug 5, 2024
luigi-asprino added a commit that referenced this issue Aug 26, 2024
enridaga added a commit that referenced this issue Sep 7, 2024
enridaga added a commit that referenced this issue Sep 10, 2024
cli help: removed deprecated option i and updated p info
luigi-asprino added a commit that referenced this issue Sep 11, 2024
luigi-asprino added a commit that referenced this issue Oct 11, 2024
luigi-asprino added a commit that referenced this issue Oct 28, 2024
luigi-asprino added a commit that referenced this issue Oct 29, 2024
luigi-asprino added a commit that referenced this issue Oct 29, 2024
luigi-asprino added a commit that referenced this issue Dec 5, 2024
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
Projects
None yet
Development

No branches or pull requests

2 participants