Setting up docs

[lalithaar]

Fixes : #54

Summary

This pull request introduces the basic structure for the project documentation. The following components have been added:

• Directory Setup: Created a dedicated docs/ folder.
• Skeleton Files: Added placeholders for key sections like Introduction, Installation, and Usage.

docs/
├── User Guide/              # For end users
│   ├── README.md            # Overview and quick start guide
│   ├── Configuration.md     # Configuring the tool based on the use case, prereq
│   ├── 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
│   ├── Changelog.md         # History of changes and updates

Feedback needed on :

1. Proposed: Moving `SECURITY.md` under Contributor Guide/. Do you agree with this organization?
2. Do you want me to add any other file / breakdown any other aspect in detail in a new file ?

To-Do

Planned updates over the next week:

• Set up the file skeleton
• Write contributing.md
• Set up a specific template to use for changelog.md
• Provide usage examples and FAQs.

Request for Feedback

Feedback on the structure or additional sections to include is welcome! If you have suggestions or improvements, please share them.

Notes

This PR is a work-in-progress and will evolve as outlined.

@gagb @jackgerrits

[lalithaar]

@microsoft-github-policy-service agree

[l-lumin]

I prefer to keep file names consistent in style, using all uppercase, like README.md and CONTRIBUTING.md

[afourney]

Agree with the need to set up more robust docs for this project. While the API is simple enough, there are many dependencies that sometimes need to be set up, and there are many optional arguments to some converters.

In this new year, I would like to discuss @jackgerrits how best to set up docs. We'll get back to you on this.

(Also, we may not be able to move SECURITY.md, etc. as they are part of the Microsoft template, and might be depended upon by various internal tools etc.)

[lalithaar]

I prefer to keep file names consistent in style, using all uppercase, like README.md and CONTRIBUTING.md

Thanks for highlighting the importance of maintaining consistent styles with all-uppercase file names. I’m still learning about best practices and was curious if this style might pose any challenges for accessibility or readability, such as with screen readers or visual clarity. Do you think it’s something worth considering?

... (Also, we may not be able to move SECURITY.md, etc. as they are part of the Microsoft template, and might be depended upon by various internal tools etc.)

Got it, Thank you