Skip to content

Create user facing documentation website #47

Open
@surajkumar

Description

@surajkumar

As a bot developer I want to...

be able to understand and use the code base

So that...

I can create discord bots using this discord library.

Context

We need some documentation and user guides for end users to be able to setup, install and use our library.
The tool we are going to use is https://docusaurus.io/ which is allows us to write our documentation using .md files. Alternatively, we can use the GitHub Wiki to achieve a similar affect.

We should pick this ticket up once the library is close to completion i.e. the core package has been implemented.

Acceptance Criteria

  • All relevant user facing code has a tutorial
  • The documentation is accessible to the public via a website
  • The docs have been reviewed and accepted by all the maintainers

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    Status

    Ready

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions