Przeglądaj źródła

documentation update: better overview about contributing to JupyterLab + move up in the menu

Katsarov 5 lat temu
rodzic
commit
28f50c09a2
2 zmienionych plików z 12 dodań i 3 usunięć
  1. 11 2
      docs/source/developer/contributing.rst
  2. 1 1
      docs/source/index.rst

+ 11 - 2
docs/source/developer/documentation.rst → docs/source/developer/contributing.rst

@@ -1,5 +1,14 @@
+Contributing to JupyterLab
+--------------------------
+
+This page provides general information about contributing to the project.
+
+.. contents:: Table of contents
+    :local:
+    :depth: 1
+
 Writing Documentation
----------------------
+~~~~~~~~~~~~~~~~~~~~~
 
 This section provides information about writing documentation for JupyterLab.
 See  our  `Contributor
@@ -7,7 +16,7 @@ Guide <https://github.com/jupyterlab/jupyterlab/blob/master/CONTRIBUTING.md>`_ f
 details on installation and testing.
 
 Writing Style
-~~~~~~~~~~~~~
+'''''''''''''
 
 -  The documentation should be written in the second person, referring
    to the reader as "you" and not using the first person plural "we."

+ 1 - 1
docs/source/index.rst

@@ -52,11 +52,11 @@ JupyterLab is the next-generation web-based user interface for Project Jupyter.
    developer/repo
    developer/extension_dev
    developer/extension_points
+   developer/contributing
    developer/documents
    developer/notebook
    developer/patterns
    developer/css
-   developer/documentation
    developer/virtualdom
    developer/examples
    developer/ui_helpers