Skip to content

feat: Improve docs for us and AI as well as pixi config#24

Open
lsetiawan wants to merge 2 commits into
mainfrom
improve-docs
Open

feat: Improve docs for us and AI as well as pixi config#24
lsetiawan wants to merge 2 commits into
mainfrom
improve-docs

Conversation

@lsetiawan

Copy link
Copy Markdown
Member

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.toml file for better modularity and maintainability.

Documentation Improvements:

  • Added a comprehensive AGENTS.md file 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.
  • Expanded the README.md with 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:

  • Refactored and modularized pixi.toml:
    • Introduced [environments] for defining default and onboard environments with associated features.
    • Defined feature-specific dependencies and tasks under [feature.<name>] sections, improving clarity and maintainability.
    • Added descriptions to tasks and clarified dependency sources (Conda vs PyPI).
    • Ensured onboarding tools like ssec-cli are 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.

@lsetiawan lsetiawan self-assigned this Oct 8, 2025
@lsetiawan lsetiawan changed the title docs: Improve docs for us and AI feat: Improve docs for us and AI as well as pixi config Oct 8, 2025

@nikiburggraf nikiburggraf left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

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.

2 participants