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

Update documentation with detailed explanations #5

Merged
merged 2 commits into from
May 9, 2024
Merged

Conversation

arlyon
Copy link
Owner

@arlyon arlyon commented May 9, 2024

Related to #4

Enhances the documentation and refactors the codebase for better clarity and structure.

  • Refactors SandboxStrategy and Capability enums by extracting them into separate files (parallelism.rs and capabilities.rs) for improved modularity and readability.
  • Documents the JSON schema for the Litehouse configuration in the settings.mdx file, providing a comprehensive overview of the settings, including imports, plugins, capabilities, and parallelism strategies.
  • Updates the plugins.mdx documentation to include information on hosting your own plugins, writing a plugin, importing plugins, and utilizing the plugin and plugin-macro crates for plugin development.
  • Introduces detailed comments and examples in the newly created parallelism.rs and capabilities.rs files, explaining the use and functionality of parallelism strategies and capabilities available to Litehouse plugins.

For more details, open the Copilot Workspace session.

Copy link

vercel bot commented May 9, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
litehouse ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 9, 2024 3:21am

@arlyon arlyon merged commit 8789bca into main May 9, 2024
1 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant