clean up bedbase docs

databio · May 24, 2024 · 9c06f2c · 9c06f2c
1 parent 430d75c
commit 9c06f2c
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 30 deletions.
diff --git a/docs/bedhost/dev-guide.md → docs/bedbase/bedbase-api-user-guide.md b/docs/bedhost/dev-guide.md → docs/bedbase/bedbase-api-user-guide.md
@@ -1,4 +1,4 @@
-# Developer Guide
+# BEDbase API user guide
 
 ## Introduction
 

diff --git a/docs/bedbase/bedbase-user-guide.md → docs/bedbase/bedbase-ui-user-guide.md b/docs/bedbase/bedbase-user-guide.md → docs/bedbase/bedbase-ui-user-guide.md
@@ -1,6 +1,16 @@
 # BEDbase public instance
 
-Do we really need documentation to document the UI?
+The public BEDbase instance at [bedbase.org](https://bedbase.org) hosts public BED files.
+
+🚧 Documentation under construction.
+
+## Resource links
+
+- **Documentation**: <a href="https://docs.bedbase.org/" target="_blank">https://docs.bedbase.org/</a>
+- **Deployed public instance UI**: <a href="https://bedbase.org/" target="_blank">https://bedbase.org/</a>
+- **Dev UI**: <a href="https://dev.bedhost.pages.dev/" target="_blank">https://dev.bedhost.pages.dev/</a>
+- **API**: <a href="https://api.bedbase.org/" target="_blank">https://api.bedbase.org/</a>
+- **Dev API**: <a href="https://dev.bedbase.org/" target="_blank">https://api-dev.bedbase.org/</a>
 
 ## Finding relevant BED files
 

diff --git a/docs/bedhost/README.md b/docs/bedhost/README.md
@@ -4,28 +4,9 @@
 [![Github badge](https://img.shields.io/badge/source-github-354a75?logo=github)](https://github.com/databio/bedhost)
 
 
-`bedhost` is a Python FastAPI module for the API that powers BEDbase
+`bedhost` is a Python FastAPI module for the API that powers BEDbase.
 It needs a path to the *bedbase configuration file*, which can be provided either via `-c`/`--config` argument or read from `$BEDBASE_CONFIG` environment variable. 
 
----
-
-**Deployed public instance**: <a href="https://bedbase.org/" target="_blank">https://bedbase.org/</a>
-
-**Documentation**: <a href="https://docs.bedbase.org/" target="_blank">https://docs.bedbase.org/bedhost</a>
-
-**API**: <a href="https://api.bedbase.org/" target="_blank">https://api.bedbase.org/</a>
-
-**API dev**: <a href="https://dev.bedbase.org/" target="_blank">https://api-dev.bedbase.org/</a>
-
-**UI**: <a href="https://bedbase.org/" target="_blank">https://bedbase.org/</a>
-
-**UI dev**: <a href="https://dev.bedhost.pages.dev/" target="_blank">https://dev.bedhost.pages.dev/</a>
-
-**Source Code**: <a href="https://github.com/databio/bedhost/" target="_blank">https://github.com/databio/bedhost/</a>
-
----
-
-
 ## Introduction
 
 You can find the formal OpenAPI documentation and interactive interface at <http://api.bedbase.org/docs>. This document provides more conceptual introduction and explanations to how to use the API effectively.

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -42,21 +42,22 @@ nav:
   - Home: README.md
   - BEDbase:
     - BEDbase: bedbase/README.md
-    - UI guide:
-      - Public BEDbase instance: bedbase/bedbase-user-guide.md
-    - API guides:
-      - BEDhost API guide:
-        - BEDhost: bedhost/README.md
-        - Developer Guide: bedhost/dev-guide.md
-        - Build image: bedhost/build_image.md
+    - User guides:
+      - Public BEDbase UI user guide: bedbase/bedbase-ui-user-guide.md
+      - Public BEDbase API user guide: bedbase/bedbase-api-user-guide.md
+    - Developer guides:
+      - BEDhost API server: 
+        - BEDhost overview: bedhost/README.md
+        - Building docker image: bedhost/build_image.md
         - Deploy API: bedhost/deployment.md
         - Changelog: bedhost/changelog.md
-      - BBConf:
+      - BBConf configuration:
         - BBConf: bbconf/README.md
         - Configuring: bedboss/how-to-configure.md
         - Overview: bbconf/overview.md
         - Guide: bbconf/bbc_api.md
         - Changelog: bbconf/changelog.md
+      - BEDBoss processing pipeline: ../bedboss
     - Reference:
       - How to cite: citations.md
       - Usage: bedboss/usage.md