Skip to content

Commit

Permalink
docs(landing page): use description from README, more detailed cards
Browse files Browse the repository at this point in the history
  • Loading branch information
JorisVincent committed Apr 7, 2023
1 parent ad8445d commit 530dbc0
Showing 1 changed file with 40 additions and 6 deletions.
46 changes: 40 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,62 @@
# stimupy

Welcome to `stimupy`
```{include} ../README.md
:start-line: 3
:end-line: 7
```

```{include} ../README.md
:start-line: 17
:end-line: 30
```

::::{grid} 2
:gutter: 3

:::{grid-item-card} Get started πŸƒ
:::{grid-item-card} Get started
:link: getting_started/getting_started
:link-type: doc
:text-align: center
πŸƒ
^^^

Install `stimupy`
and follow an introductory tutorial
:::

:::{grid-item-card} Learn more πŸ§‘β€πŸ«
:::{grid-item-card} Learn more
:link: topic_guides/topic_guides
:link-type: doc
:text-align: center
πŸ§‘β€πŸ«
^^^

Learn more about design decisions
and particular conventions and topics within `stimupy`
:::

:::{grid-item-card} Reference πŸ“‘
:::{grid-item-card} Reference
:link: reference/api
:link-type: doc
:text-align: center
πŸ“‘
^^^

Look up functions and their specific parameters,
including through interactive demos

:::

:::{grid-item-card} Get in touch πŸ“¨, contribute 🎁
:::{grid-item-card} Get in touch, or contribute
:link: contributing/get_in_touch
:link-type: doc
:::
:text-align: center
πŸ“¨, 🎁
^^^

Ask a question,
report a bug,
request a feature,
or contribute.
:::
::::

0 comments on commit 530dbc0

Please sign in to comment.