Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Insufficient Documentation for Custom Backend Integration #274

Open
code-with-parth opened this issue Jan 19, 2025 · 3 comments
Open

Insufficient Documentation for Custom Backend Integration #274

code-with-parth opened this issue Jan 19, 2025 · 3 comments
Assignees
Labels

Comments

@code-with-parth
Copy link

Description:
The repository lacks comprehensive documentation or examples for developers who wish to integrate custom backends into the CrossGL translator. This creates a steep learning curve for contributors attempting to expand the tool’s capabilities.

Steps to Reproduce:

  1. Attempt to add a new backend (e.g., Vulkan or Metal) to the translator.

  2. Refer to the existing documentation for guidance.

  3. Observe that the documentation provides little to no information on backend integration.

Expected Behavior:
The documentation should include a detailed guide on creating and integrating custom backends, with examples and best practices.

Actual Behavior:
There is no structured guide or sufficient information for this task, requiring developers to deduce the process from the codebase, leading to inefficiencies.

Environment Details:

OS: Ubuntu 22.04

Python Version: 3.10

Additional Context:

While the codebase is modular, understanding the interaction between components like lexer.py, parser.py, and backend-specific files is challenging without proper guidance.

Adding a "Custom Backend Integration" section to the documentation would be beneficial for the community.

@code-with-parth
Copy link
Author

@CrossGL-issue-bot assign me

@Rahulmathur2301
Copy link

@CrossGL-issue-bot assign me

@CrossGL-issue-bot
Copy link

Thank you for taking on this issue! If you have any questions or need assistance, feel free to ask.

@github-actions github-actions bot added the stale label Feb 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants