[2023-10-15] Detailed Guides for Users, Developers, and Contributors (sec-parser)

[Elijas]

Hello Alphanome.AI Community,

We're thrilled to introduce a streamlined roadmap that will guide you through the layers of our open-source project, sec-parser. This roadmap is your compass, whether you're a user looking to utilize the library, a developer aiming to dive deep into the code, or a contributor keen on making an impact.

To maximize your experience and contributions, we've prepared four guides that are best read in the following order:

1. Step 1: Introduction to Contributing
   Common Contributing Guide
   Start here for an overview of environment setup, coding standards, and general contribution workflows across our repositories.

2. Step 2: Become a User
   User Guide
   After setting up your environment, familiarize yourself with the core functionalities of sec-parser. This guide covers how to install and use the library to parse SEC EDGAR HTML documents.

3. Step 3: Advance to Developer
   Developer Guide
   Once you're comfortable using sec-parser, this guide will take you under the hood. You'll learn about the architecture, key components, and examples to help you understand the codebase.

4. Step 4: Contribute Like a Pro
   Contributing Guide
   Now that you're well-versed with sec-parser, this guide will navigate you through the contribution process specific to this project. Discover how you can make meaningful contributions.

We strongly recommend following these guides in sequence for a comprehensive understanding and efficient contribution to the project.

As always, your feedback and suggestions are invaluable to us. Thank you for being an integral part of the sec-parser, sec-ai, and the Alphanome.AI community. Stay tuned for further updates!

Best,
Elijas