feat: Improve docs for us and AI as well as pixi config#24
Open
lsetiawan wants to merge 2 commits into
Open
Conversation
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.
This pull request significantly improves the documentation and configuration for onboarding and development workflows in the project template. The changes clarify how to use Pixi for environment management, add detailed onboarding and contribution instructions, and restructure the
pixi.tomlfile for better modularity and maintainability.Documentation Improvements:
AGENTS.mdfile that provides detailed, step-by-step instructions for using Pixi, running pre-commit checks, onboarding, adding dependencies, and troubleshooting common issues. This serves as a guide for both AI assistants and human contributors.README.mdwith clear sections on prerequisites, installation, onboarding, project structure, available environments, development workflows, and contribution guidelines, making it easier for new users to get started and understand project conventions.Configuration and Environment Management:
pixi.toml:[environments]for definingdefaultandonboardenvironments with associated features.[feature.<name>]sections, improving clarity and maintainability.ssec-cliare only included in the appropriate environment.These changes collectively provide a much smoother onboarding experience, enforce best practices, and make the project template more robust and user-friendly for both new and experienced contributors.