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

Idea for changing how docs are maintained #11

Open
billkendrick opened this issue Jan 9, 2021 · 1 comment
Open

Idea for changing how docs are maintained #11

billkendrick opened this issue Jan 9, 2021 · 1 comment

Comments

@billkendrick
Copy link
Contributor

I was confused/surprised that dist-doc is in Github when it's generated, based on what's in doc. The Makefile simply seems to copy them, en-masse, from one directory to the other. Is there a reason this is done?

It's also a little tedious to create or edit the doc files on a non-Atari (e.g., vi on Linux), since the EOL characters are Atari specific. I'm thinking we can use modern EOL in the doc files, and then simply translate them as part of the copying process.

i.e., rather than the (more-or-less) cp doc/* dist-doc/ that's in Makefile now, use tr '\233' '\n' < doc/FILE.DOC > dist-doc/FILE.DOC or somesuch...?

@billkendrick
Copy link
Contributor Author

Having the DOCs in something GitHub understands (and doesn't assume is just "binary file") would also make diff'ing easier :)

billkendrick added a commit that referenced this issue Jan 9, 2021
Was confused over `dist-doc` vs `doc`; see
#11
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

No branches or pull requests

1 participant