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

Create full documentation. #33

Open
9 of 12 tasks
stepanzubkov opened this issue Aug 8, 2023 · 0 comments
Open
9 of 12 tasks

Create full documentation. #33

stepanzubkov opened this issue Aug 8, 2023 · 0 comments
Assignees
@stepanzubkov
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@stepanzubkov
Copy link
Contributor

stepanzubkov commented Aug 8, 2023 •
edited
Loading

I prefer docs in markdown format, so I want to use it for cc-api docs.

  • Rewrite README
    • Add information about license
    • Add contribution mini-guide
    • Rewrite deploy guide
    • Add logo (optional)
    • Add information about clients (cc-cli, cc-web)
  • Add API docs in docs/ folder
    • Describe all url/ methods
    • Describe all paste/ methods
    • Add examples (curl + maybe python)
    • Describe Url and Paste models.
    • Mini-guide for contributors, that describes code structure and code style

All docs should be initially written in English and later translated to Russian. Maybe other languages, if I find translators.
@stepanzubkov stepanzubkov added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 8, 2023
@stepanzubkov stepanzubkov self-assigned this Aug 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@stepanzubkov stepanzubkov

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone
No milestone
Development

No branches or pull requests
1 participant
@stepanzubkov