Skip to content

docs: clarify how activation works in practice#5598

Merged
baszalmstra merged 1 commit intoprefix-dev:mainfrom
stinos:shelldocs
Mar 17, 2026
Merged

docs: clarify how activation works in practice#5598
baszalmstra merged 1 commit intoprefix-dev:mainfrom
stinos:shelldocs

Conversation

@stinos
Copy link
Copy Markdown
Contributor

@stinos stinos commented Mar 3, 2026

Description

Add basic examples of pixi shell-hook usage since those seemed to be missing so far and make it clear that pixi shell should never be put in a shell's startup file.

Fixes part of #5510.

Note: theare are also other documents touching on activation, like https://pixi.prefix.dev/latest/workspace/environment/#activation and https://pixi.prefix.dev/latest/advanced/pixi_shell/, but I left those as-is because imo this basic yet important information should be put where it is most likely to be looked for i.e. next to the command's own explanation.

On the other hand something like https://pixi.prefix.dev/latest/advanced/pixi_shell/#issues-with-pixi-shell is almost about the exact same change I made in shell.md so please advise if this needs to be structured in a different way.
Perhaps simply linking directly to the relevant .md files in the aformentiond links would already help? It's a bit weird to have a page dedicated to shell without actually linking to its core documentation?

How Has This Been Tested?

I only looked at the docs in a markdown previewer: don't know how else to check.

@baszalmstra baszalmstra changed the title docs: Clarify how activation works in practice docs: clarify how activation works in practice Mar 17, 2026
@baszalmstra baszalmstra merged commit d332ab6 into prefix-dev:main Mar 17, 2026
41 checks passed
@baszalmstra
Copy link
Copy Markdown
Contributor

Thanks!

@stinos stinos deleted the shelldocs branch March 18, 2026 09:33
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