From 05ff59db5bd630ea962bda94110f44a2ebc3f5e5 Mon Sep 17 00:00:00 2001 From: Benjamin Bach Date: Wed, 21 Dec 2022 14:08:54 +0100 Subject: [PATCH] Understand the "Science" page as Explanation and add framing to introduction --- docs/user/index.rst | 2 +- docs/user/science.rst | 9 ++++++--- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/user/index.rst b/docs/user/index.rst index 201a90532f9..53b4e351925 100644 --- a/docs/user/index.rst +++ b/docs/user/index.rst @@ -82,6 +82,7 @@ to help you create fantastic documentation for your project. /custom-domains /pull-requests /downloadable-documentation + /science .. toctree:: :maxdepth: 2 @@ -92,7 +93,6 @@ to help you create fantastic documentation for your project. /guides/authors /guides/administrators /guides/developers - /science /examples diff --git a/docs/user/science.rst b/docs/user/science.rst index 11ea7a2fc06..928bc6c1b38 100644 --- a/docs/user/science.rst +++ b/docs/user/science.rst @@ -1,5 +1,9 @@ -Read the Docs for Science -========================= +Documentation in scientific and academic publishing +=================================================== + +On this page, we explore some of the many tools and practices that *software* documentation and *academic* writing share. +If you are working within the field of science or academia, +this page can be used as an introduction. .. 2022-08-10 .. Notes about this section: @@ -20,7 +24,6 @@ Documentation and technical writing are broad fields. Their tools and practices have grown relevant to most scientific activities. This includes building publications, books, educational resources, interactive data science, resources for data journalism and full-scale websites for research projects and courses. -Let's explore the overlap of features for software documentation and academic writing. Here's a brief overview of some :doc:`features ` that people in science and academic writing love about Read the Docs: .. dropdown:: 🪄 Easy to use