dogecoin icon indicating copy to clipboard operation
dogecoin copied to clipboard

Published 20 hours ago • verified publisher icon dogecoin

Organize internationalized documentation

Open patricklodder opened this issue 11 months ago • 6 comments

Implements proposal from #3436

  1. Creates a new structure in doc/intl/, where each language gets their own folder and a central README.md that lists all translated documents
  2. Moves current translated README files into this structure
  3. Removes cross linking, introduces hierarchical linking

patricklodder avatar Feb 29 '24 16:02 patricklodder

Missed this a few months ago—it definitely seems like an improvement from how we do things right now.

slightlyskepticalpotat avatar Apr 02 '24 17:04 slightlyskepticalpotat

Accidentally did a bad commit so I had to fix it.

patricklodder avatar Apr 11 '24 21:04 patricklodder

Nice, looks good. Although, I'm thinking now too that there should also be a policy written somewhere explaining this part of your proposal:

"... All translated documents are required to be up-to-date by release time, or they will be deleted and unlinked from the release (depending on which branching strategy we'll pursue). This prevents distributing outdated information with a release."

Perhaps it would be good to write that in doc/intl/README.md, as I think that's probably the most likely place for contributors and maintainers to look.

daank-c avatar Apr 11 '24 23:04 daank-c

Nice, looks good. Although, I'm thinking now too that there should also be a policy written somewhere explaining this part of your proposal:

"... All translated documents are required to be up-to-date by release time, or they will be deleted and unlinked from the release (depending on which branching strategy we'll pursue). This prevents distributing outdated information with a release."

Perhaps it would be good to write that in doc/intl/README.md, as I think that's probably the most likely place for contributors and maintainers to look.

If you also want to help organise the documentation here https://dogecoincore.com/ I will appreciate it, you can do so easily here https://github.com/qlpqlp/dogecoin-core-docs/tree/main/ Just clone and on src/ folder you will see all languages, but for now only src/en/ is all documented

I don't mind to move this repo to dogecoin repo because it will only contain CORE documentation :)

qlpqlp avatar Apr 12 '24 00:04 qlpqlp

@qlpqlp I don't have time for any more commitments atm, sorry fren.

daank-c avatar Apr 12 '24 13:04 daank-c

@qlpqlp I don't have time for any more commitments atm, sorry fren.

No worries <3, I will then update wen I have some more motivation :) (time I always find out, motivation is the only barrier for me at the moment lol)

qlpqlp avatar Apr 12 '24 13:04 qlpqlp

Rebased, redid the move of the now newer fa_IR readme, and squashed the punctuation fixup.

patricklodder avatar Jun 24 '24 17:06 patricklodder