Skip to content

Commit

Permalink
Update page-titling convention to use frontmatter-style titles
Browse files Browse the repository at this point in the history
  • Loading branch information
johnkerl authored and ihnorton committed Apr 7, 2022
1 parent 9603c47 commit c1b78b6
Show file tree
Hide file tree
Showing 14 changed files with 43 additions and 15 deletions.
4 changes: 3 additions & 1 deletion format_spec/FORMAT_SPEC.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Format Specification
---
title: Format Specification
---

**Notes:**

Expand Down
4 changes: 3 additions & 1 deletion format_spec/array_file_hierarchy.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Array File Hierarchy
---
title: Array File Hierarchy
---

An array is a folder with the following structure:

Expand Down
4 changes: 3 additions & 1 deletion format_spec/array_metadata.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Array Metadata
---
title: Array Metadata
---

## Main Structure

Expand Down
4 changes: 3 additions & 1 deletion format_spec/array_schema.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Array Schema
---
title: Array Schema
---

## Current Array Schema Version

Expand Down
4 changes: 3 additions & 1 deletion format_spec/consolidated_commits_file.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Consolidated Commits File
---
title: Consolidated Commits File
---

A consolidated commits file has name `<timestamped_name>.con` and is located here:

Expand Down
4 changes: 3 additions & 1 deletion format_spec/consolidated_fragment_metadata_file.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Consolidated Fragment Metadata File
---
title: Consolidated Fragment Metadata File
---

A consolidated fragment metadata file has name `<timestamped_name>.meta` and is located here:

Expand Down
4 changes: 3 additions & 1 deletion format_spec/filter_pipeline.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Filter Pipeline
---
title: Filter Pipeline
---

## Main Structure

Expand Down
4 changes: 3 additions & 1 deletion format_spec/fragment.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Fragment
---
title: Fragment
---

## Main Structure

Expand Down
4 changes: 3 additions & 1 deletion format_spec/generic_tile.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Generic Tile
---
title: Generic Tile
---

The generic tile is a [tile](./tile.md) prepended with some extra header data, so that it can be used stand-alone without requiring extra information from the array schema. A generic tile has the following on-disk format:

Expand Down
6 changes: 4 additions & 2 deletions format_spec/group_file_hierarchy.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Group File Hierarchy
---
title: Group File Hierarchy
---

A TileDB group is a folder with a single file in it:

Expand All @@ -7,4 +9,4 @@ my_group # Group folder
|_ __tiledb_group.tdb # Empty group file
```

File `__tiledb_group.tdb` is empty and it is merely used to indicate that `my_group` is a TileDB group.
File `__tiledb_group.tdb` is empty and it is merely used to indicate that `my_group` is a TileDB group.
4 changes: 3 additions & 1 deletion format_spec/ignore_file.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Ignore File
---
title: Ignore File
---

A ignore file has name `__t1_t2_uuid_v.ign` and is located in the array commit folder:

Expand Down
4 changes: 3 additions & 1 deletion format_spec/tile.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Tile
---
title: Tile
---

## Main Structure

Expand Down
4 changes: 3 additions & 1 deletion format_spec/vacuum_file.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Vacuum File
---
title: Vacuum File
---

A vacuum file has name `__t1_t2_uuid_v.vac` and can be located either in the array commit folder:

Expand Down
4 changes: 3 additions & 1 deletion index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Public code docs
---
title: Public code docs
---

This is public documentation of the code within this repository.

0 comments on commit c1b78b6

Please sign in to comment.