Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,155 changes: 0 additions & 1,155 deletions DST_DATABASE_SCHEMA_PLAN.md

This file was deleted.

105 changes: 0 additions & 105 deletions docs/dev/documentation-guide/07-react-components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3465,111 +3465,6 @@ import TableBestFitDistributions from '@site/src/components/TableBestFitDistribu

---

## Schema Components (DST Database)

These components are used exclusively in the DST database schema documentation (`docs/dev/dst/database-schema/`).

### SchemaTableCompact

**Purpose:** Compact table displaying a database table's schema — column names, types, constraints, and optional grouping.

**Import:**

```jsx
import SchemaTableCompact from '@site/src/components/SchemaTableCompact';
```

**Usage:**

```jsx
<SchemaTableCompact
name="Locations"
description="Stores geographic location data."
status="implemented"
columns={[
{ name: 'LocationID', type: 'int', pk: true, description: 'Primary key' },
{ name: 'Name', type: 'nvarchar(200)', description: 'Location name' },
]}
/>
```

**Props:**

<TableVerticalNoRef
alt="Table: Prop, Type, Required, Description"
headers={[[{ value: 'Prop' }, { value: 'Type' }, { value: 'Required' }, { value: 'Description' }]]}
columns={[
['<code>name</code>', '<code>description</code>', '<code>status</code>', '<code>columns</code>', '<code>notes</code>', '<code>jsonSchemas</code>', '<code>id</code>'],
['String', 'String', 'String', 'Array', 'String', 'Array', 'String'],
['Yes', 'No', 'No', 'Yes', 'No', 'No', 'No'],
['Table name', 'Table description', '<code>"implemented"</code> (default), <code>"partial"</code>, or <code>"planned"</code>', 'Array of column definition objects', 'Additional notes', 'JSON schema examples', 'Custom HTML id'],
]}
/>

---

### SchemaTag

**Purpose:** Inline colored tag/badge for labeling schema elements (e.g., primary keys, foreign keys, data types).

**Import:**

```jsx
import SchemaTag from '@site/src/components/SchemaTag';
```

**Usage:**

```jsx
<SchemaTag type="pk">Primary Key</SchemaTag>
<SchemaTag type="fk" href="#locations-table">LocationID</SchemaTag>
```

**Props:**

<TableVerticalNoRef
alt="Table: Prop, Type, Required, Description"
headers={[[{ value: 'Prop' }, { value: 'Type' }, { value: 'Required' }, { value: 'Description' }]]}
columns={[
['<code>type</code>', '<code>children</code>', '<code>href</code>', '<code>title</code>'],
['String', 'Node', 'String', 'String'],
['Yes', 'Yes', 'No', 'No'],
['Tag style type (e.g., <code>"pk"</code>, <code>"fk"</code>)', 'Label content', 'If provided, renders as a link', 'Tooltip text'],
]}
/>

---

### SchemaRelationshipDiagram

**Purpose:** Data-driven entity relationship diagram rendered with CSS flexbox, showing table relationships within DST database modules.

**Import:**

```jsx
import SchemaRelationshipDiagram from '@site/src/components/SchemaRelationshipDiagram';
```

**Usage:**

```jsx
{/* Show all modules and relationships */}
<SchemaRelationshipDiagram />

{/* Filter to a single module */}
<SchemaRelationshipDiagram moduleId="common" />
```

**Props:**

<TableVerticalNoRef
alt="Table: Prop, Type, Required, Description"
headers={[[{ value: 'Prop' }, { value: 'Type' }, { value: 'Required' }, { value: 'Description' }]]}
columns={[['<code>moduleId</code>'], ['String'], ['No'], ['Filter diagram to a single module. When omitted, all modules are shown.']]}
/>

---

## Component Best Practices

### General Guidelines
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,6 @@ Contains all custom React components used throughout the documentation site. The
- `EventTree.js` - Event tree diagrams with download
- `EventTreeTOC.js` - Event tree table of contents
- `Counters.js` - Build-time counter utility
- `ModuleMap.js` - Module diagram rendering
- `DocChapterNav.js` - Chapter-level navigation

**Landing Page Components:**
Expand All @@ -125,17 +124,9 @@ Contains all custom React components used throughout the documentation site. The
- `TourButton.js` - Tour launch button
- `VersionNotice.js` - Version mismatch notice (used internally by NavContainer)

**Schema Components (DST Database):**

- `SchemaGroup.js` - Schema group container
- `SchemaTable.js` - Database schema table
- `SchemaTableCompact.js` - Compact schema table variant
- `SchemaTag.js` - Schema tag labels
- `SchemaRelationshipDiagram.js` - Entity relationship diagrams

**Icon Components (`src/components/icons/`):**

19 SVG icon components for landing pages and navigation: `CodeIcon`, `DesktopAppIcon`, `DocumentationGuideIcon`, `DSTDatabaseIcon`, `DSTIcon`, `GitHubIcon`, `InternalErosionIcon`, `LSTIcon`, `OvertoppingIcon`, `RiskCalculationsIcon`, `RiverineErosionIcon`, `RRFTIcon`, `SeismicHazardIcon`, `SparkleIcon`, `SpillwayErosionIcon`, `StructuralIcon`, `StyleGuideIcon`, `ToolboxIcon`, `WebAppIcon`
18 SVG icon components for landing pages and navigation: `CodeIcon`, `DesktopAppIcon`, `DocumentationGuideIcon`, `DSTIcon`, `GitHubIcon`, `InternalErosionIcon`, `LSTIcon`, `OvertoppingIcon`, `PythonIcon`, `RiskCalculationsIcon`, `RiverineErosionIcon`, `RRFTIcon`, `SeismicHazardIcon`, `SparkleIcon`, `SpillwayErosionIcon`, `StructuralIcon`, `ToolboxIcon`, `WebAppIcon`

### Component Architecture

Expand Down Expand Up @@ -300,14 +291,6 @@ Global styles for table components:
- Responsive table behavior
- Table caption formatting

**schema.css**

Global styles for DST database schema components:

- Schema table and group layout
- Schema tag colors and sizing
- Relationship diagram styling

**chapter-nav.css**

Styles for the `DocChapterNav` chapter navigation component:
Expand Down Expand Up @@ -370,7 +353,6 @@ The primary use case is for the RMC Typical Event Tree Database document, which
**Files:**

- `eventTreeToc.json` — Table of contents data for the Typical Event Tree Database
- `dstSchemaData.js` — Schema metadata for DST database documentation

**Generated By:** `scripts/generateEventTreeTOC.js` and build-time data extraction

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@ These files and folders are created automatically by the scripts above:
alt="Table: File/Folder, Generated By, Purpose"
headers={[[{ value: 'File/Folder' }, { value: 'Generated By' }, { value: 'Purpose' }]]}
columns={[
['<code>src/imageDimensions.js</code>', '<code>src/reportIdMap.js</code>', '<code>sidebars.js</code>', '<code>static/counters/*.json</code>', '<code>static/versions/*.json</code>', '<code>src/data/eventTreeToc.json</code>', '<code>src/data/dstSchemaData.js</code>', '<code>.docusaurus/</code>', '<code>build/</code>'],
['<code>src/imageDimensions.js</code>', '<code>src/reportIdMap.js</code>', '<code>sidebars.js</code>', '<code>static/counters/*.json</code>', '<code>static/versions/*.json</code>', '<code>src/data/eventTreeToc.json</code>', '<code>.docusaurus/</code>', '<code>build/</code>'],
['generateImageDimensions.js', 'generateReportIdMap.js', 'generateSidebars.js', 'counters.js', 'versions.js', 'generateEventTreeTOC.js', 'Build process', 'Docusaurus', 'Docusaurus'],
['Image dimension metadata', 'Document ID mappings', 'Navigation structure', 'Figure/table/equation numbering', 'Version management', 'Event tree navigation', 'DST schema data', 'Build cache', 'Production output'],
]}
Expand Down
27 changes: 0 additions & 27 deletions docs/dev/dst/database-schema/v1.0/00-document-info.mdx

This file was deleted.

42 changes: 0 additions & 42 deletions docs/dev/dst/database-schema/v1.0/01-preface.mdx

This file was deleted.

37 changes: 0 additions & 37 deletions docs/dev/dst/database-schema/v1.0/02-schema-reference.mdx

This file was deleted.

34 changes: 0 additions & 34 deletions docs/dev/dst/database-schema/v1.0/03-screening-management.mdx

This file was deleted.

Loading
Loading