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.

Sign up for GitHub

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

Jump to bottom

improve readme and .md files for better readability #1945

Closed
privatemaker opened this issue Feb 7, 2023 · 3 comments
Closed

improve readme and .md files for better readability #1945

privatemaker opened this issue Feb 7, 2023 · 3 comments
Labels
0. Needs triage Pending approval or rejection. This issue is pending approval. enhancement New feature or request

Comments

@privatemaker
Copy link

privatemaker commented Feb 7, 2023 •
edited
Loading

Is your feature request related to a problem? Please describe.

While manageable, the existing readme.md at 682 lines is getting a bit long and less than ideal to find what one is looking for quickly.

Describe the solution you'd like

I can think of three solutions:

  1. Tuck more information into <details><summary>... collapsible sections
  2. Split up readme.md and migrate along with other .md files to static site like docs.nextcloud.com
  3. Use Github Wiki feature

Describe alternatives you've considered

Personally, I think option 2. is better fitting as it allows nicer styling and attention to various things. Followed by option 3.

Additional context

I am happy to contribute either solution if it well received.
@privatemaker privatemaker added 0. Needs triage Pending approval or rejection. This issue is pending approval. enhancement New feature or request labels Feb 7, 2023
@privatemaker privatemaker changed the title imrpove readme and .md files for better readability improve readme and .md files for better readability Feb 7, 2023
@DenuxPlays
Copy link
Contributor

Can't we use the github wiki feature?
Would be a good option too I guess.

@privatemaker
Copy link
Author

@DenuxPlays true. updated my issue

@szaimen
Copy link
Collaborator

szaimen commented Feb 7, 2023

Hi, see #826

@szaimen szaimen closed this as completed Feb 7, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 22, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
0. Needs triage Pending approval or rejection. This issue is pending approval. enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@szaimen @privatemaker @DenuxPlays