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

Build a Sphinx website to document GCBM Belize #12

Open
Namyalg opened this issue Jun 24, 2022 · 0 comments · May be fixed by #16
Open

Build a Sphinx website to document GCBM Belize #12

Namyalg opened this issue Jun 24, 2022 · 0 comments · May be fixed by #16

Comments

@Namyalg
Copy link
Member

Namyalg commented Jun 24, 2022 •
edited

What does the current documentation state?
Currently, the Belize project does not have a ReadTheDocs website

Why do you want to improve the statement?
I want to build the website as it will increase the accessibility of the project

Proposed statement
I propose the following documentation structure :

└── Project/
    ├── About project
    ├── Where it fits in the big picture
    ├── Prerequisites for the dev setup
    ├── Guide to using the project


Feedback page can be included at the end of every section/page based on the content

I will try using the https://www.npmjs.com/package/rate-the-docs for the feedback funnel
@Namyalg Namyalg linked a pull request Aug 27, 2022 that will close this issue
Open
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

sphinx website for the documentation Namyalg/GCBM.Belize
1 participant
@Namyalg