Skip to content

Create a documentation site #3

Description

@laraibg786

We need to create a github pages site using mkdocs-material to provide the documentation of the app. This should at least document the following aspects of the app.

  1. user guide (with steps to add this to required checks).
  2. steps to install this app.
  3. steps to create your own codeCurfew app and self-hosting.
  4. motivation behind the project.
  5. expected behavior with different cases.
  6. documentation about the format of the .codecurfew config file to configure the behavior.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions