Skip to content

docs: Add documentation summarizing the internals of the tagged DFA and illustrating compression and search usage. #1908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SharafMohamed wants to merge 18 commits into
base: main
Choose a base branch
from
+572 −0
Open

docs: Add documentation summarizing the internals of the tagged DFA and illustrating compression and search usage. #1908

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
fec5a7f
Doc added.
SharafMohamed Jan 26, 2026
1d76e0a
Add search example.
SharafMohamed Jan 26, 2026
37ea775
Add labels.
SharafMohamed Jan 26, 2026
7a7c290
Fix typos.
SharafMohamed Jan 26, 2026
e4e8524
Add new line before heading fence.
SharafMohamed Jan 26, 2026
a2dfafd
Remove unused headings.
SharafMohamed Jan 26, 2026
9c83157
Update search section.
SharafMohamed Jan 27, 2026
f3a24dd
Update compression example.
SharafMohamed Jan 27, 2026
632aad1
Update compression example execution table and explanation; Update TD…
SharafMohamed Jan 28, 2026
513d16e
Switch to none for codeblocks.
SharafMohamed Jan 28, 2026
baf6a10
Fix heading spacing.
SharafMohamed Jan 28, 2026
bdfdd45
Grammar fix.
SharafMohamed Jan 28, 2026
2fc8e26
Fix accidental footnote.
SharafMohamed Jan 28, 2026
c171930
Fix indentation.
SharafMohamed Jan 28, 2026
bb7fc90
Grammar fix.
SharafMohamed Jan 28, 2026
6b96a5a
Change title and overview statement.
SharafMohamed Jan 28, 2026
5b03a29
Rename readme.
SharafMohamed Jan 28, 2026
d4605ba
Add new doc to index.
SharafMohamed Feb 5, 2026
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
14 changes: 14 additions & 0 deletions docs/src/dev-docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,13 @@ Components
Docs specific to each component.
:::

:::{grid-item-card}
:link: schema-based-compression-and-search
Schema
^^^
Docs about compression and search using user-defined schemas.
:::

:::{grid-item-card}
:link: tooling-containers
Tooling
Expand Down Expand Up @@ -82,6 +89,13 @@ components-core/index
components-webui
:::

:::{toctree}
:caption: Schema
:hidden:

schema-based-compression-and-search
:::

:::{toctree}
:caption: Tooling
:hidden:
Expand Down
Loading