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

Add doc directory #53

Open
4 of 8 tasks
Arfey opened this issue Dec 10, 2018 · 5 comments
Open
4 of 8 tasks

Add doc directory #53

Arfey opened this issue Dec 10, 2018 · 5 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@Arfey
Copy link
Member

Arfey commented Dec 10, 2018

When u create service you need to write documentation about it. It's good practice and one point to the karma :). It will be great if create-aio-app quickly provides a way to do this.

So, what need to do:

  • create doc directory (use sphinx for that)
  • write description about:
    • about the project's architecture
    • developing
    • testing
  • add command to make file for generate docs
  • publish this doc using github's pages or some else
  • add auto deploy docs for each release or push into master
@Arfey Arfey added the good first issue Good for newcomers label Dec 10, 2018
@aio-libs aio-libs deleted a comment from aio-libs-bot Dec 10, 2018
@aio-libs-bot aio-libs-bot added enhancement New feature or request and removed good first issue Good for newcomers labels Dec 10, 2018
@Arfey Arfey added the good first issue Good for newcomers label Dec 24, 2018
@Arfey
Copy link
Member Author

Arfey commented Dec 25, 2018

This was referenced Jan 11, 2019
@Arfey Arfey added the help wanted Extra attention is needed label Apr 18, 2019
@anthony-aleman
Copy link

Is this issue still available? I would like to take this on

@Arfey
Copy link
Member Author

Arfey commented Sep 27, 2021

Yes, it is 🙂

@AkshatGoel-321
Copy link

please allow me to work on remaining tasks if available

@Arfey
Copy link
Member Author

Arfey commented Sep 8, 2022

sure

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants