RAD-154: Improve documentation (#386)

* Added new schemas to documentation. Rearranged docs so product schemas are at the top. * add a change log * fix change log link * fix wording
spacetelescope · Feb 28, 2024 · ae17bd0 · ae17bd0
1 parent 0c8f514
commit ae17bd0
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 11 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -1,6 +1,8 @@
 0.19.1 (unreleased)
 -------------------
 
+- Add new schemas to documentation. [#386]
+
 - Convert tag keywords to wildcards for external tags. [#370]
 
 - Added ``exact_datatype`` arguments to prevent ASDF from casting array

diff --git a/docs/index.rst b/docs/index.rst
@@ -4,12 +4,13 @@
 Roman Attribute Dictionary
 **************************
 
-The Roman Attribute Dictionary (RAD) is package which defines schemas for the Nancy Grace
-Roman Space Telescope shared attributes for processing and archive.
+The Roman Attribute Dictionary (RAD) is a package which defines schemas for the Nancy Grace
+Roman Space Telescope files. Metadata attributes are used by both Science Data Processing and
+the Archive Keyword Dictionary.
 
 .. note::
-  These schemas are schemas for the :ref:`ASDF file <asdf-standard:asdf-standard>` file format, which
-  are used by ASDF to serialize and deserialize data for the Nancy Grace Roman Space Telescope.
+  These are schemas for the :ref:`ASDF file <asdf-standard:asdf-standard>` file format,
+  used by ASDF to serialize and deserialize data for the Nancy Grace Roman Space Telescope.
 
 Included Resources
 ==================

diff --git a/docs/reference_files.rst b/docs/reference_files.rst
@@ -1,7 +1,7 @@
 .. _reference_files:
 
-Reference Files
-===============
+Reference File Schemas
+======================
 
 Nancy Grace Roman Space Telescope Reference Files:
 
@@ -12,13 +12,16 @@ Nancy Grace Roman Space Telescope Reference Files:
     distortion-1.0.0
     flat-1.0.0
     gain-1.0.0
+    inverselinearity-1.0.0
+    ipc-1.0.0
     linearity-1.0.0
     mask-1.0.0
     pixelarea-1.0.0
     readnoise-1.0.0
     ref_common-1.0.0
     ref_exposure_type-1.0.0
     ref_optical_element-1.0.0
+    refpix-1.0.0
     saturation-1.0.0
     superbias-1.0.0
     wfi_img_photom-1.0.0
diff --git a/docs/schemas.rst b/docs/schemas.rst
@@ -1,13 +1,36 @@
 .. _schemas:
 
-Schemas
-=======
+Science Products Schemas
+========================
 
-The RAD schemas:
+Level 1 (uncalibrated) File schema
+----------------------------------
+
+.. asdf-autoschemas::
+
+  wfi_science_raw-1.0.0
+
+Level 2 (calibrated exposure) File schema
+-----------------------------------------
+
+.. asdf-autoschemas::
+
+   wfi_image-1.0.0
+
+Level 3 (resampled mosaic) File schema
+--------------------------------------
+
+.. asdf-autoschemas::
+
+  wfi_mosaic-1.0.0
+
+Tags
+----
 
 .. asdf-autoschemas::
 
     aperture-1.0.0
+    associations-1.0.0
     basic-1.0.0
     cal_logs-1.0.0
     cal_step-1.0.0
@@ -19,6 +42,11 @@ The RAD schemas:
     guidestar-1.0.0
     guidewindow_modes-1.0.0
     guidewindow-1.0.0
+    individual_image_meta-1.0.0
+    mosaic_associations-1.0.0
+    mosaic_basic-1.0.0
+    mosaic_wcsinfo-1.0.0
+    msos_stack-1.0.0
     observation-1.0.0
     photometry-1.0.0
     pointing-1.0.0
@@ -27,11 +55,12 @@ The RAD schemas:
     ramp_fit_output-1.0.0
     ramp-1.0.0
     ref_file-1.0.0
+    resample-1.0.0
+    source_detection-1.0.0
     target-1.0.0
     velocity_aberration-1.0.0
     visit-1.0.0
+    wcsinfo-1.0.0
     wfi_detector-1.0.0
-    wfi_image-1.0.0
     wfi_mode-1.0.0
     wfi_optical_element-1.0.0
-    wfi_science_raw-1.0.0