Open
Conversation
Contributor
|
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 ✍️ ✅ |
Author
|
I have read the CLA Document and I hereby sign the CLA |
c8281a5 to
d00c2f6
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 .