Guidance about GitHub About panel

appliedfm · Nov 29, 2021 · 2d41504 · 2d41504
1 parent bebc9fe
commit 2d41504
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/docs/source/project_structure.rst b/docs/source/project_structure.rst
@@ -28,6 +28,18 @@ Requirements vary by project.
 * Use `coqdoc <https://coq.inria.fr/refman/using/tools/coqdoc.html>`_, `alectryon <https://github.com/cpitclaudel/alectryon/>`_, and/or `sphinx <https://www.sphinx-doc.org>`_.
 
 
+Repository documentation
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+If the project is hosted on GitHub:
+
+* Ensure the "About" panel is up-to-date
+   * Website
+   * Readme
+   * License
+   * Topics include ``coq``
+
+
 Dependencies
 ------------