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

tw blue documentation is out of date #557

Open
Arfs6 opened this issue Aug 27, 2023 · 3 comments
Open

tw blue documentation is out of date #557

Arfs6 opened this issue Aug 27, 2023 · 3 comments

Comments

@Arfs6
Copy link
Contributor

Arfs6 commented Aug 27, 2023

Tw blue docs is out of date. Everything.
Are there any specifications or guidelines? Which topics to cover? I am thinking of gradually adding the docs.

@manuelcortez
Copy link
Member

I have a basic new documentation system (built with sphinx). As english is not my native language and due to work stuff I have not done anything in english for a very long time, i am not sure if I can continue it. I will update it so we can start from there if you want. This should give us a good starting point.

@Arfs6
Copy link
Contributor Author

Arfs6 commented Oct 11, 2023

That will be great. Is that what is in the documentation branch?

I just checked sphinx docs and getting started guide, and it seems to be the right tool for the job.

@Arfs6
Copy link
Contributor Author

Arfs6 commented Dec 18, 2023

I just checked the new-documentation branch.

  1. The mastodon.rst file has a basic outline of the structure of the document. I'll fill the necessary info and push it.
  2. How do you update the change log? Manually? There is a very big hole in that file.
  3. There is lot of info on twitter. I am thinking of removing everything and just stating that TW Blue used to support twitter, but it doesn't any more. What do you think?
  4. Is there anything you would like me to do?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants