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

Reorganize docs to prepare automatic pdf doc build #50

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

simone-weiss
Copy link
Collaborator

@simone-weiss simone-weiss commented Nov 14, 2024

Changes

  • Reorganize docs so that a pdf version can be generated with pandoc
  • Add a script to build this pdf
  • Add a gh action to build and upload a pdf as an asset on tag creation

Dependencies:

none

Tests results

n.a.

Developer Checklist:

  • Test: Changes are tested
  • Doc: Documentation has been updated
  • Git: Informative git commit message(s)
  • Issue: If a related GitHub issue exists, linking is done

Checklists for documentation

  • Grammar: the content is grammatically correct
    (spelling, grammar, formatting, US English is used)
  • Comprehensibility/Unambiguousness: the content is easy readable, clear to understand
  • Correctness and consistency: the content is technically correct and consistent,
    no contradictions, no double descriptions
  • Terminology: technical terms are clear and they are used correctly and documented in the glossary
  • Level of detail: the content matches the detail level necessary for the reviewed object

Reviewer checklist:

  • Review: Changes are reviewed
  • Review: Tested by the reviewer

Checklists for documentation

  • Grammar: the content is grammatically correct
    (spelling, grammar, formatting, US English is used)
  • Comprehensibility/Unambiguousness: the content is easy readable, clear to understand
  • Correctness and consistency: the content is technically correct and consistent,
    no contradictions, no double descriptions
  • Terminology: technical terms are clear and they are used correctly and documented in the glossary
  • Level of detail: the content matches the detail level necessary for the reviewed object

@simone-weiss
Copy link
Collaborator Author

EBcL_SDK.pdf
pdf created

@thir820
Copy link
Collaborator

thir820 commented Nov 15, 2024

@simone-weiss There is something broken with the $$RESULTS$$. It's rendered as a headline. Except this it looks good.

@simone-weiss
Copy link
Collaborator Author

@simone-weiss There is something broken with the R E S U L T S . It's rendered as a headline. Except this it looks good.

Fixed. I would suggest to add now a small script to generate that pdf and maybe run it always once we tag via an action?

@thir820
Copy link
Collaborator

thir820 commented Nov 15, 2024

@simone-weiss There is something broken with the R E S U L T S . It's rendered as a headline. Except this it looks good.

Fixed. I would suggest to add now a small script to generate that pdf and maybe run it always once we tag via an action?

+1

@simone-weiss simone-weiss marked this pull request as ready for review November 15, 2024 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants