FujiNetWIFI / FujiNetWIFI/fujinet-tools

Idea for changing how docs are maintained

Open
#11 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
C
Stars
15
Forks
15
PR merge metrics
No merged PRs in 30d

Description

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...?

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the Makefile and compare the files in doc and dist-doc to confirm how the current copy works and how Atari-specific EOL characters are represented. Check whether dist-doc is expected to remain tracked. Done means the maintenance approach is decided and the copy process consistently produces the intended documentation files.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.