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

rusEFI book - documentation in linear form #250

Open
rusefillc opened this issue Nov 14, 2022 · 8 comments
Open

rusEFI book - documentation in linear form #250

rusefillc opened this issue Nov 14, 2022 · 8 comments
Labels
needs-more-info requestor or contributor needs to provide feedback

Comments

@rusefillc
Copy link
Contributor

We have four instanced of wiki but @ElDominio is confident that a "book", i.e. a linear representation of the same content is something of a high priority

@rusefillc
Copy link
Contributor Author

Somewhat related to #168

@rusefillc
Copy link
Contributor Author

"the book" does not imply that we move the source of truth into a linear form

I guess for PDF purposes content would have to be copy-pasted say once a year. In order to facilitate the once a year PDF production I guess first we need an amazing index wiki page such that once a year one could go through many pages in the order of the index and copy-paste content into a PDF book.

@mi-hol
Copy link
Contributor

mi-hol commented Jan 20, 2023

How to create pdf from md is described in #1 (comment)

@mi-hol
Copy link
Contributor

mi-hol commented Jan 31, 2023

Updated
dependency for creating a book is from my view to finish task:
'add relevant docs from "orphaned" md files list to WIKI index / Table of Content' in #297

@ElDominio would you see yourself in a position to contribute to this task?

@mi-hol mi-hol added the needs-more-info requestor or contributor needs to provide feedback label Jan 31, 2023
@mi-hol
Copy link
Contributor

mi-hol commented Jan 31, 2023

"the book" does not imply that we move the source of truth into a linear form

Referencing all relevant documents in the 'Table of Content' makes it kind of a "linear" story.
A good story is required for any book to make it successful.

@mi-hol
Copy link
Contributor

mi-hol commented Jan 31, 2023

first we need an amazing index wiki page

we are aligned on this task :)

@mi-hol
Copy link
Contributor

mi-hol commented Feb 2, 2023

I guess for PDF purposes content would have to be copy-pasted say once a year. In order to facilitate the once a year PDF production I guess first we need an amazing index wiki page such that once a year one could go through many pages in the order of the index and copy-paste content into a PDF book.

the manual copy-paste process can be replaced with automation outlined in #1

@rusefillc
Copy link
Contributor Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-more-info requestor or contributor needs to provide feedback
Projects
None yet
Development

No branches or pull requests

2 participants