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

Suggestion: move articles to Github's repository's Wiki section #1

Open
mardab opened this issue Sep 22, 2023 · 0 comments
Open

Suggestion: move articles to Github's repository's Wiki section #1

mardab opened this issue Sep 22, 2023 · 0 comments

Comments

@mardab
Copy link

mardab commented Sep 22, 2023

Dear mr. Lee,
For a while I was indecisive whether to PR indexed/cleaned up README.md file of this repository, akin to my previous work pulled in lupyuen/pinephone-nuttx#1 , given the fact, that this one contains much more pictures than code, and so even adding a small index to mark sections of it does not improve readability, searchability, and upkeep of its contents by a substantial amount, and rendering this file by itself is a non-trivial task for older and mobile devices, not to mention browsing it via Github's webpage.

I propose in my opinion a much more sustainable solution, and that would be to move those more in-detail articles to wiki section, which, being Markdown compatible and having an automated indexing of articles sounds like an easy to do and future-proof change, should the number and size of these articles grow even more.

Given that starting up and editing Wiki section requires elevated permissions, to be able to perform this myself, I have to ask you to create first page and decide on permissions model for this section first.

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