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

Creating a read the docs for the project using pages #4

Open
Mochitto opened this issue Apr 21, 2023 · 1 comment
Open

Creating a read the docs for the project using pages #4

Mochitto opened this issue Apr 21, 2023 · 1 comment
Assignees
@Diego-1995
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@Mochitto
Copy link
Owner

Right now the Readme is very packed with information and can seem very menacing.
It would be much nicer if the project had a doc page with all of the useful information.
@Mochitto Mochitto added the enhancement New feature or request label Apr 21, 2023
@Mochitto Mochitto added the help wanted Extra attention is needed label Jan 22, 2024
@Mochitto
Copy link
Owner Author

The github page should be built using either read-the-docs or jekyll.
Information on how to setup a jekyll page can be found here.

The idea is transposing the README, CONTRIBUTING and other files to the jekyll website, to make it more accessible.
High priority is to be given to accessibility: refer to the a11y project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Diego-1995 Diego-1995

Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
Markdown2Anki
Status: Backlog
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Diego-1995 @Mochitto