Skip to content

Commit e957795

Browse files
authored
fix: nicer landing pages (#194)
Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>
1 parent fa5101d commit e957795

3 files changed

Lines changed: 56 additions & 20 deletions

File tree

docs/_includes/interactive_repo_review.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
root.render(
2020
<App
2121
header={false}
22-
deps={["sp-repo-review==2023.06.17", "repo-review==0.7.0"]}
22+
deps={["sp-repo-review==2023.06.17", "repo-review==0.8.0"]}
2323
/>
2424
);
2525
</script>

docs/pages/guides/index.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,23 @@ and one for [compiled extensions][gha_wheels]. You can read about setting up
2727
good tests on the [pytest page][pytest]. There's also a page on setting up
2828
[docs][], as well.
2929

30-
Once you have completed the guidelines, there is a [copier][]/[cookiecutter][]
31-
project, [scientific-python/cookie][], that implements these guidelines and lets
32-
you setup a new package from a template in less than 60 seconds!
30+
{: .highlight-title }
3331

34-
You can also evaluate your repository against the guidelines by using
35-
[scientific-python-repo-review][]!
32+
> New project template
33+
>
34+
> Once you have completed the guidelines, there is a
35+
> [copier][]/[cookiecutter][]/[cruft][] project, [scientific-python/cookie][],
36+
> that implements these guidelines and lets you setup a new package from a
37+
> template in less than 60 seconds! Twelve build backends including compiled
38+
> backends, generation tested in Nox, and kept in-sync with the guide.
39+
40+
{: .important-title }
41+
42+
> Checking an existing project
43+
>
44+
> We provide [sp-repo-review][], a set of [repo-review][] checks for comparing
45+
> your repository with the guidelines, runnable right in the guide via
46+
> WebAssembly! All checks point to a linked badge in the guide.
3647
3748
<!-- prettier-ignore-start -->
3849

@@ -46,10 +57,12 @@ You can also evaluate your repository against the guidelines by using
4657
[gha_pure]: {% link pages/guides/gha_pure.md %}
4758
[gha_wheels]: {% link pages/guides/gha_wheels.md %}
4859
[pytest]: {% link pages/guides/pytest.md %}
49-
[scientific-python-repo-review]: {% link pages/guides/repo_review.md %}
60+
[sp-repo-review]: {% link pages/guides/repo_review.md %}
5061

5162
[cookiecutter]: https://cookiecutter.readthedocs.io
5263
[copier]: https://copier.readthedocs.io
64+
[cruft]: https://cruft.github.io/cruft
65+
[repo-review]: https://repo-review.readthedocs.io
5366
[scientific-python/cookie]: https://github.com/scientific-python/cookie
5467

5568
<!-- prettier-ignore-end -->

docs/pages/index.md

Lines changed: 36 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,34 @@ nav_order: 0
1010
This guide is maintained by the scientific Python community for the benefit of
1111
fellow scientists and research software engineers.
1212

13-
**Learn the essentials.** Do you have a pile of scientific Python scripts or
13+
**Start at the basics.** Do you have a pile of scientific Python scripts or
1414
Jupyter notebooks that are becoming unwieldy? Are changes to some parts of your
1515
code accidentally breaking other parts of your code? Do you want to more
1616
maintainable, reusable, and shareable form? Start at the
1717
[tutorial]({% link pages/tutorials/index.md %}).
1818

19-
**Learn recommended tools and best practices.** [Topical
20-
guides]({% link pages/guides/index.md %}) provide task-based instruction on
21-
topics that scientists and research software engineers may encounter as their
22-
projects evolve and grow. This covers everything from writing and building
23-
documentation to modern Python packaging. This comes with a
24-
[copier][]/[cookiecutter][] template for making new repos,
25-
[scientific-python/cookie][], and [sp-repo-review][], a tool for comparing your
26-
repository with the guidelines, runnable in WebAssembly.
19+
**Learn recommended tools and best practices.** [Topical guides]({% link
20+
pages/guides/index.md %}) provide task-based instruction on topics that scientists
21+
and research software engineers may encounter as their projects evolve and grow.
22+
This covers [modern packaging][], [style checking][], [testing][], [documentation][],
23+
[static typing][], [CI][], and much more!
24+
25+
{: .highlight-title }
26+
27+
> New project template
28+
>
29+
> This guide comes with a [copier][]/[cookiecutter][]/[cruft][] template for
30+
> making new repos, [scientific-python/cookie][]. Twelve build backends
31+
> including compiled backends, generation tested in Nox, and kept in-sync with
32+
> the guide.
33+
34+
{: .important-title }
35+
36+
> Checking an existing project
37+
>
38+
> We provide [sp-repo-review][], a set of [repo-review][] checks for comparing
39+
> your repository with the guidelines, runnable right in the guide via
40+
> WebAssembly! All checks point to a linked badge in the guide.
2741
2842
**Learn to write better research code.** A high-level document on
2943
[principles]({% link pages/principles/index.md %}) provides advice based on the
@@ -38,15 +52,24 @@ Python packages.
3852
## Related Resources
3953

4054
This guide does _not_ cover the basics of Python itself or the scientific Python
41-
libraries. We recommend the [SciPy Lecture Notes](https://scipy-lectures.org/).
55+
libraries; it focuses on making or maintaining a package. We recommend the
56+
[SciPy Lecture Notes](https://scipy-lectures.org/) if you want info.
4257

4358
This guide also does not cover version control, but it is essential to have a
4459
basic facility with git to use these tools successfully. We recommend the
4560
[Software Carpentry lesson on git](https://swcarpentry.github.io/git-novice/).
4661

4762
<!-- prettier-ignore-start -->
4863
[scientific-python/cookie]: https://github.com/scientific-python/cookie
49-
[sp-repo-review]: {% link pages/guides/repo_review.md %}
50-
[copier]: https://copier.readthedocs.io
51-
[cookiecutter]: https://cookiecutter.readthedocs.io
64+
[modern packaging]: {% link pages/guides/packaging_simple.md %}
65+
[style checking]: {% link pages/guides/style.md %}
66+
[testing]: {% link pages/guides/pytest.md %}
67+
[documentation]: {% link pages/guides/docs.md %}
68+
[static typing]: {% link pages/guides/mypy.md %}
69+
[ci]: {% link pages/guides/gha_pure.md %}
70+
[sp-repo-review]: {% link pages/guides/repo_review.md %}
71+
[repo-review]: https://repo-review.readthedocs.io
72+
[copier]: https://copier.readthedocs.io
73+
[cookiecutter]: https://cookiecutter.readthedocs.io
74+
[cruft]: https://cruft.github.io/cruft
5275
<!-- prettier-ignore-end -->

0 commit comments

Comments
 (0)