Skip to content

Create full documentation. #33

Open
@stepanzubkov

Description

@stepanzubkov

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.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions