Skip to content

DOC: Clean up front page a bit. Add back cards. #145

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.

Sign up for GitHub

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

Merged
arokem merged 1 commit into from
Sep 10, 2026
Merged

DOC: Clean up front page a bit. Add back cards. #145

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 18 additions & 10 deletions docs/source/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,28 @@
# TRX in Python

This software library implements the TRX file format for
tractography in the Pythonprogramming language.
This software library implements the [TRX file format](https://tee-ar-ex.github.io) for
tractography in the Python programming language.

## Getting Started
::::{grid} 2
:::{grid-item-card} Getting Started
```{toctree}
:maxdepth: 1
installation
auto_examples/index
```
:::

1. **Understand the format**: To understand the TRX file structure and learn Why TRX, please refer to the [TRX homepage](https://tee-ar-ex.github.io).
2. **Installation** To install the library, follow the instructions in the {doc}`installation` documentation page.
3. **Learn by example**: Follow our {doc}`auto_examples/index` to learn how to read, write, and manipulate TRX files
4. **Use the CLI tools**: Check out the {doc}`scripts` documentation for command-line operations
:::{grid-item-card} User Guide
```{toctree}
:maxdepth: 1
scripts
autoapi/index
```
:::
::::


```{toctree}
:maxdepth: 2
installation
scripts
dev
autoapi/index
```
Loading