From dfdf270dd5dc0f319232a6ee67b41392111c8ad1 Mon Sep 17 00:00:00 2001 From: Leah Wasser Date: Wed, 2 Aug 2023 15:09:53 -0600 Subject: [PATCH] Fix: broken nav --- documentation/index.md | 31 +++++++++------------ index.md | 28 ------------------- package-structure-code/intro.md | 48 ++++++++++++++++++++++++++++++++- 3 files changed, 60 insertions(+), 47 deletions(-) diff --git a/documentation/index.md b/documentation/index.md index e2507376..23d1aa71 100644 --- a/documentation/index.md +++ b/documentation/index.md @@ -43,7 +43,6 @@ Publish Your Docs Website Hosting and Optimization ``` - ```{important} Please note that the tools discussed here are those that we see commonly used in the community. As tools evolve we @@ -104,13 +103,13 @@ Python workflows. They might be new(er) to Python and/or data science. Or expert programmers. But they might not have a background in software development. These users need to know: - * How to install your package - * How to install dependencies that your package requires - * How to get started using the code base - * Information on how to cite your code / give you credit if they are using it - in a research application. - * Information on the license that your code uses so they know how they can - or can't use the code in an operational setting. +- How to install your package +- How to install dependencies that your package requires +- How to get started using the code base +- Information on how to cite your code / give you credit if they are using it + in a research application. +- Information on the license that your code uses so they know how they can + or can't use the code in an operational setting. ### 2. Potential tool contributors @@ -118,16 +117,16 @@ The other subset of users are more experienced and/or more engaged with your package. As such they are potential contributors. These users: -* might have a software development background, -* might also be able to contribute bug fixes to your package or updates to your documentation -* might also just be users who will find spelling errors in your documentation, or bugs in your tutorials. +- might have a software development background, +- might also be able to contribute bug fixes to your package or updates to your documentation +- might also just be users who will find spelling errors in your documentation, or bugs in your tutorials. These users need all of the things that a basic user needs. But, they also need to understand how you'd like for them to contribute to your package. These potential contributors need: -* A development guide to help them understand the infrastructure used in your package repository. -* Contributing guidelines that clarify the types of contributions that you welcome and how you'd prefer those contributions to be submitted. +- A development guide to help them understand the infrastructure used in your package repository. +- Contributing guidelines that clarify the types of contributions that you welcome and how you'd prefer those contributions to be submitted. ```{important} It's important to remember that the definition of what a contribution is can be @@ -136,7 +135,6 @@ spelling issue in your documentation. Or it could be a code fix that includes a new test that covers an edge-case that they discovered. ``` - ## Documentation elements that pyOpenSci looks for reviewing a Python package In the pyOpenSci open peer review, we look for @@ -149,12 +147,12 @@ that you should consider in your package's documentation in more detail. - ```{button-link} https://www.pyopensci.org/software-peer-review/how-to/editor-in-chief-guide.html#editor-checklist-template :color: primary :class: sd-rounded-pill float-left View pyOpenSci peer review check list ``` +