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

Organize internationalized documentation #3459

Open
wants to merge 4 commits into
base: 1.15.0-dev
Choose a base branch
from

Conversation

patricklodder
Copy link
Member

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

@slightlyskepticalpotat
Copy link
Contributor

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

README.md Outdated Show resolved Hide resolved
Removes crosslinking of documentation in favor of a link hierarchy:

- main README.md links to doc/intl/README.md
- doc/intl/README.md links to individual translated documents

This reduces conflicts between translations.
@patricklodder
Copy link
Member Author

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

@daank-c
Copy link
Contributor

daank-c commented Apr 11, 2024

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.

@qlpqlp
Copy link
Contributor

qlpqlp commented Apr 12, 2024

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 :)

@daank-c
Copy link
Contributor

daank-c commented Apr 12, 2024

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

@qlpqlp
Copy link
Contributor

qlpqlp commented Apr 12, 2024

@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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Review & merge board
🚀 needs review
Development

Successfully merging this pull request may close these issues.

None yet

4 participants