Skip to content
This repository was archived by the owner on Sep 27, 2025. It is now read-only.

feat/setup-mkdocs-and-add-usage-examples #65

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat/setup-mkdocs-and-add-usage-examples #65

wants to merge 3 commits into from

Conversation

Azizadx
Copy link

@Azizadx Azizadx commented Jun 2, 2024 •
edited
Loading

This PR is a work in progress. The goal is to create clear and straightforward documentation as requested in issue #43.

Task List for PR:

  • Set Up Documentation Framework

    • Set up MkDocs for the project.
    • Configure MkDocs to publish with GitHub Pages.

  • Add Documentation Content

    • Include usage examples.
    • Write detailed installation instructions.
    • Provide a full overview of supported functionality.

@github-actions github-actions bot added the enhancement New feature or request label Jun 2, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@ritchie46 ritchie46 Awaiting requested review from ritchie46 ritchie46 is a code owner

@stinodego stinodego Awaiting requested review from stinodego

@universalmind303 universalmind303 Awaiting requested review from universalmind303 universalmind303 is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@Azizadx