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

📝 Documentation next steps: checklist #94

Open
6 tasks
jbesomi opened this issue Jul 15, 2020 · 2 comments
Open
6 tasks

📝 Documentation next steps: checklist #94

jbesomi opened this issue Jul 15, 2020 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@jbesomi
Copy link
Owner

jbesomi commented Jul 15, 2020

This document attempt at giving an order of importance of tasks related to improving the documentation of the website.

  • Add the "Edit on Github" button in every Texthero web-page

Getting started

Expected documents:

  1. Getting Started
  2. Preprocessing (see Getting started: preprocessing #144)
  3. Representation
  4. NLP
  5. Visualization
  6. HeroSeries
  • Write the "Preprocessing" page under Getting Started
  • Write the "Representation" page under Getting Started
  • Write the "NLP" page under Getting Started
  • Write the "Visualization" page under Getting Started
  • Write the "Kind of Series"/"HeroSeries" under Getting Started Getting started: Kind of Series (HeroSeries) #135

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

@jbesomi jbesomi pinned this issue Jul 15, 2020
@jbesomi jbesomi changed the title Documentation Next steps: checklist 📝 Documentation Next steps: checklist Jul 15, 2020
@jbesomi jbesomi added the documentation Improvements or additions to documentation label Jul 15, 2020
@jbesomi jbesomi changed the title 📝 Documentation Next steps: checklist 📝 Documentation next steps: checklist Jul 15, 2020
@mk2510
Copy link
Collaborator

mk2510 commented Aug 31, 2020

@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 :octocat:
We will link the pull request later on here. 🥇

@jbesomi
Copy link
Owner Author

jbesomi commented Sep 1, 2020

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
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants