Skip to content

[Feature]: Make it easier to add documenation #1759

@bikash119

Description

@bikash119

Problem

While working on the issue #1623, a few issues I encountered:

  • As we have contributing docs for compoenents like backend, gateway, I couldn't find contributing docs for documents.
  • The setup.py doesn't have mkdocs dependencies. A new contributor need to install the dependencies based on the failure message from mkdocs build command.

Solution

pip install -e .[docs] should install all the required dependencies for someone to build mkdocs.

Workaround

No response

Would you like to help us implement this feature by sending a PR?

Yes

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions