@gagb @jackgerrits

Please share your feedback on the proposed /docs folder structure. I plan to work on creating the documentation over the next week and submit a pull request after the New Year.

I will break down the existing README into smaller chunks, ensuring that the main README.md is simple to skim through, while redirecting users to the detailed docs as needed.

Wishing you and the team a Merry Christmas to those who are celebrating! :]

docs/
├── User Guide/              # For end users
│   ├── README.md            # Overview and quick start guide
│   ├── Installation.md      # Steps to install the tool
│   ├── Configuration.md     # Configuring the tool based on use case
│   ├── Usage.md             # Detailed usage instructions
│   ├── FAQ.md               # FAQ, Support and glossary
│
├── Contributor Guide/       # For developers and contributors
│   ├── Contributing.md      # How to contribute to the project
│   ├── Code_of_conduct.md   # Community behavior guidelines
│   ├── SECURITY.md          # Reporting security vulnerabilities
│   ├── LICENSE.md           # Licensing details
│   ├── Changelog.md         # History of changes and updates

MarkItDown documentation #54

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions