Skip to content

docs: add how pixi works section with mermaid diagram#5887

Open
EfeAkkus wants to merge 2 commits intoprefix-dev:mainfrom
EfeAkkus:docs/how-pixi-works
Open

docs: add how pixi works section with mermaid diagram#5887
EfeAkkus wants to merge 2 commits intoprefix-dev:mainfrom
EfeAkkus:docs/how-pixi-works

Conversation

@EfeAkkus
Copy link
Copy Markdown

@EfeAkkus EfeAkkus commented Apr 13, 2026

Description

Fixes #{issue}

How Has This Been Tested?

AI Disclosure

  • This PR contains AI-generated content.
    • I have tested any AI-generated content in my PR.
    • I take responsibility for any AI-generated content in my PR.

Tools: {e.g., Claude, Codex, GitHub Copilot, ChatGPT, etc.}

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added sufficient tests to cover my changes.
  • I have verified that changes that would impact the JSON schema have been made in schema/model.py.

Comment thread docs/getting_started.md
Comment on lines +28 to +37
```mermaid
flowchart TB
add[pixi add] -->|writes| toml[pixi.toml]
toml -->|reads| lock[pixi lock]
lock -->|writes| lockfile[pixi.lock]
lockfile -->|reads| install[pixi install]
install -->|writes| env[.pixi/]
run[pixi run] -.->|auto-triggers| install
install -.->|auto-triggers| lock
```
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.

I don't think this is a clean enough diagram to really explain how things interact with each other.

It comes very close to the information trying to convey in this pr: #5881

Assuming you're both at the PyCon sprints. Maybe you two could discuss?

I simplified the diagram to make it cleaner and easier to read.
Here is the updated version:

- Changed the layout from top-to-bottom to left-to-right
- Removed the extra auto-triggers arrow to reduce complexity
- Made it clearer which boxes are commands and which are files
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