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

PDF for appendix documents, yaml index #12

Closed
maldins46 opened this issue Feb 10, 2021 · 0 comments · Fixed by #17
Closed

PDF for appendix documents, yaml index #12

maldins46 opened this issue Feb 10, 2021 · 0 comments · Fixed by #17
Labels
documentation Improvements or additions to documentation

Comments

@maldins46
Copy link
Contributor

I write this issue as a reminder for the me of the future. I think it could be better to generate also a separate pdf for the appendix documents of the repository, as they are part of the documentation, actually. They should be merged into a single document.

As a further optimization, it could be nice to have a sort of index for each repo, written in Yaml, as I have seen it could be done easily. This could make the order of the chapters independent of their name.

In addition, a separate Yaml fine should be used also to store metadata, instead of including them inside documents. I think this would make the files cleaner, and also easier to read from the GitHub standard interface for markdown.

@maldins46 maldins46 added the documentation Improvements or additions to documentation label Feb 10, 2021
@maldins46 maldins46 added this to Backlog in ScalaQuest Project via automation Feb 10, 2021
@maldins46 maldins46 moved this from Backlog to In progress (current Sprint) in ScalaQuest Project Feb 15, 2021
@maldins46 maldins46 linked a pull request Feb 17, 2021 that will close this issue
ScalaQuest Project automation moved this from In progress (current Sprint) to Done tasks (current sprint) Feb 19, 2021
@maldins46 maldins46 moved this from Done tasks (current sprint) to Done tasks (post Sprint) in ScalaQuest Project Feb 25, 2021
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
ScalaQuest Project
Done tasks (post Sprint)
Development

Successfully merging a pull request may close this issue.

1 participant