-
Notifications
You must be signed in to change notification settings - Fork 240
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
📝 Documentation next steps: checklist #94
Labels
documentation
Improvements or additions to documentation
Comments
@jbesomi, as we now have implemented the API-checklist, we will now focus more on the documentation part. There we (@henrifroese and I) will start writing, the visualisation, representation, nlp tutorial and also a developer documentation |
Perfect! For the topic modeling tutorial, something similar to this one might be a good start: discovering-hidden-topics-python |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
This document attempt at giving an order of importance of tasks related to improving the documentation of the website.
Getting started
Expected documents:
Aim
The documentation is probably one of the most important part of the whole project. We want to explain clearly to new users what Texthero is about and let them start using it quickly and effortlessly.
For example, reading the "getting started" should be a smooth and simple lecture. The different doc pages should be linked together and the "getting started" should appear as a story.
Also, it's important to have a unified view: the language and the structure of each page should be clear. Different pages should still share a similar structure.
Each page needs to have a clear and specific goal, clear both to the writer and also shared with the public. The first sentence of the page document should mention that. "The aim of this page is to explain ..."
See the discussion here for some extra comments: #135
Useful resources / Inspiration
This document is a WIP
The text was updated successfully, but these errors were encountered: