Skip to content

Commit e0f3fdb

Browse files
make more links to documentation and tests sections
1 parent 78ff4dd commit e0f3fdb

File tree

1 file changed

+48
-3
lines changed

1 file changed

+48
-3
lines changed

index.md

Lines changed: 48 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,26 +144,71 @@ Learn about best practices for:
144144
:gutter: 3
145145

146146
::::{grid-item}
147-
:::{card} ✨ Write & Publish Docs ✨
147+
:::{card} ✨ Write The Docs ✨
148148
:class-card: left-aligned
149149

150150
* [Create documentation for your users](/documentation/write-user-documentation/intro)
151151
* [Core files to include in your package repository](/documentation/repository-files/intro)
152+
* [Write tutorials to show how your package is used](/documentation/write-user-documentation/create-package-tutorials)
153+
:::
154+
::::
155+
156+
::::{grid-item}
157+
:::{card} ✨ Developer Docs ✨
158+
:class-card: left-aligned
159+
160+
* [Create documentation for collaborating developers](/documentation/repository-files/contributing-file)
161+
* [Write a development guide](/documentation/repository-files/development-guide)
162+
:::
163+
::::
164+
165+
::::{grid-item}
166+
:::{card} ✨ Document For A Community ✨
167+
:class-card: left-aligned
168+
169+
* [Writing a README file](/documentation/repository-files/readme-file-best-practices)
170+
* [Set norms with a Code of Conduct](/documentation/repository-files/code-of-conduct)
171+
* [License your package](/documentation/repository-files/license-files)
172+
:::
173+
::::
174+
175+
::::{grid-item}
176+
:::{card} ✨ Publish Your Docs ✨
177+
:class-card: left-aligned
178+
152179
* [How to publish your docs](/documentation/hosting-tools/intro)
180+
* [Using Sphinx](/documentation/hosting-tools/intro)
181+
* [Markdown, MyST, and ReST](/documentation/hosting-tools/myst-markdown-rst-doc-syntax)
182+
* [Host your docs on Read The Docs or Github Pages](/documentation/hosting-tools/publish-documentation-online)
153183
:::
154184
::::
155185

186+
:::::
187+
188+
## Tests
189+
190+
*We are actively working on this section. [Follow development here.](https://github.com/pyOpenSci/python-package-guide)*
191+
192+
:::::{grid} 1 1 2 2
193+
:class-container: text-center
194+
:gutter: 3
195+
156196
::::{grid-item}
157197
:::{card} ✨ Tests for your Python package ✨
158198
:class-card: left-aligned
159199

160200
* [Intro to testing](tests/index.md)
161201
* [Write tests](tests/write-tests)
162202
* [Types of tests](tests/test-types)
203+
:::
204+
::::
205+
206+
::::{grid-item}
207+
:::{card} ✨ Run your tests ✨
208+
:class-card: left-aligned
209+
163210
* [Run tests locally](tests/run-tests)
164211
* [Run tests in CI](tests/tests-ci)
165-
166-
*We are actively working on this section. [Follow development here.](https://github.com/pyOpenSci/python-package-guide)*
167212
:::
168213
::::
169214
:::::

0 commit comments

Comments
 (0)