Skip to content

Commit af64bac

Browse files
authored
Merge pull request #62 from rclune/patch-4
Update GitHub repository links in documentation
2 parents 204f909 + 9058274 commit af64bac

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

content/documentation/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ layout: playbook
77
The OMSF Documentation Playbook aims to make it easier for developers to integrate documentation into their projects from the very beginning. It offers guidance on the types of documentation most valuable to both developers and users, along with a [companion GitHub repository](https://github.com/omsf/OMSF_docs_template) that provides a ready-to-use setup for automatically generated API documentation. Together, these resources help ensure your projects are clear, accessible, and welcoming to both users and contributors.
88

99
## Audience
10-
While the guidance in this playbook applies to projects in any programming language, the accompanying [OMSF_docs_template repository](https://github.com/omsf/OMSF_docs_template) is structured around a Python project, and many examples throughout the text draw from Python-based codebases.
10+
While the guidance in this playbook applies to projects in any programming language, the accompanying [OMSF_template_repo](https://github.com/omsf/OMSF_template_repo) is structured around a Python project, and many examples throughout the text draw from Python-based codebases.
1111

1212
## How to Use This Playbook
1313
The Playbook is organized by the type of documentation. Each section will describe the specific piece of documentation in increasing detail with writing tips interspersed throughout. Note that the types of documentation discussed here are just what the authors recommend to have for open source software projects, especially open source scientific software projects. Some items might not be applicable to your project or your project might need documentation not explicitly mentioned.
1414

15-
There is a [companion GitHub repository](https://github.com/omsf/OMSF_docs_template) for this Playbook! It contains:
15+
There is a [companion GitHub repository](https://github.com/omsf/OMSF_template_repo) for this Playbook! It contains:
1616
- A starting setup for using Sphinx to generate the static HTML pages that will make up your external documentation that you can copy into your own project or copy into a new repo for a new project.
1717
- Template markdown files that can be filled out and used in the external documentation for your project.
1818
- Ready-to-use infrastructure for automatically generating API documentation for your modules and submodules.

0 commit comments

Comments
 (0)