Update documentation#141
Conversation
|
Hi Meydan, thanks a lot for your PR. We really appreciate the effort. We’re currently using MK Docs for our documentation and don’t have plans to migrate away from it. If you’re interested in contributing further, it would be great to have your help improving the existing documentation. |
|
All contributors have signed the CLA ✍️ ✅ |
|
I have read the CLA Document and I hereby sign the CLA |
c8281a5 to
d00c2f6
Compare
|
Thanks a lot @Medyan-Naser for this contribution. I have discovered this automatic documentation page: Considering this page (which updates automatically based on the latest in the repo), I think we may not need this PR any longer. What do you think? |
|
DeepWiki is useful and does a good job auto-generating docs, but we can’t fully verify its accuracy or control how complete it is at any point. Also, my PR adds first-time usage examples and a quick start guide for XLB, which is missing from DeepWiki and is usually what helps most with onboarding. So I think it still makes sense to keep and maintain our internal docs. |
Contributing Guidelines
Description
This PR adds a full documentation website for the XLB project using Sphinx and Read the Docs.
README.mdhas been split into multiple structured pages.api_referencepage has been added for future automated API documentation.docs/folder was created to hold the Sphinx project files..readthedocs.ymlfile was added to configure the Read the Docs build.This setup provides a scalable and maintainable structure for XLB documentation going forward.
Type of change
How Has This Been Tested?
Linting and Code Formatting
Make sure the code follows the project's linting and formatting standards. This project uses Ruff for linting.
To run Ruff, execute the following command from the root of the repository:
ruff check .