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

docs: more structured toc #1142

Merged
merged 16 commits into from
Apr 9, 2024
Merged

Conversation

tdejager
Copy link
Contributor

@tdejager tdejager commented Apr 8, 2024

I tried to improve the structure of the TOC.

My ideas:

  • Getting started section (main entry point)
  • Tutorials and examples first as next entry for reading.
  • Project configuration about different manifests.
  • List of features to go in depth with the features
  • Advanced with more advanced topics that are less likely to be read on first read
  • Reference section for reference like documentation
  • Misc with misc

Things I want to improve but not in this PR.

  1. Create a What is Pixi section similar to what is bun.
  2. Have a managing dependencies section in the features similar to: https://python-poetry.org/docs/managing-dependencies/
  3. Seeing if we can have a toggle for pyproject.toml and pixi.toml in some places.

@tdejager tdejager requested a review from ruben-arts April 8, 2024 13:39
@tdejager
Copy link
Contributor Author

tdejager commented Apr 8, 2024

Also @pavelzw I've kinda upgraded the design proposal for multi env to a feature description. Let me know if this makes sense, seeing as you were the last person editing it I think.

Copy link
Contributor

@ruben-arts ruben-arts left a comment

Choose a reason for hiding this comment

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

Thanks for taking some time on the documentation!

docs/advanced/multi_environment.md Outdated Show resolved Hide resolved
mkdocs.yml Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
@pavelzw
Copy link
Contributor

pavelzw commented Apr 8, 2024

While you're at it: am I the only one who finds _ in urls a bit odd? I personally would prefer https://pixi.sh/dev/advanced/github-actions instead of https://pixi.sh/dev/advanced/github_actions

@tdejager tdejager changed the title doc: more structured toc docs: more structured toc Apr 8, 2024
Copy link
Contributor

@ruben-arts ruben-arts left a comment

Choose a reason for hiding this comment

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

I started indenting the configuration.md file but it needs more, so please check it in the ide

docs/reference/configuration.md Outdated Show resolved Hide resolved
docs/reference/configuration.md Outdated Show resolved Hide resolved
docs/tutorials/ros2.md Outdated Show resolved Hide resolved
tdejager and others added 5 commits April 9, 2024 09:21
@pavelzw
Copy link
Contributor

pavelzw commented Apr 9, 2024

conda-forge/staged-recipes#25985

@tdejager
Copy link
Contributor Author

tdejager commented Apr 9, 2024

conda-forge/staged-recipes#25985

That's great!

@ruben-arts
Copy link
Contributor

Thanks tim, going to enable automerge

@ruben-arts ruben-arts enabled auto-merge (squash) April 9, 2024 13:37
@ruben-arts ruben-arts merged commit cb4bcbc into prefix-dev:main Apr 9, 2024
28 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.

3 participants