Skip to content

Commit 348ec43

Browse files
committed
Documentation: Update README and backlog
1 parent 4bc7ef6 commit 348ec43

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ uv tool install --upgrade 'cratedb-about[all] @ git+https://github.com/crate/abo
8989
The `cratedb-about` package provides three subsystems.
9090

9191
- Outline: Read and inquire outline files.
92-
- Bundle: Produce context output bundles from outline files.
92+
- Bundle: Produce a context bundle from an outline file.
9393
- Query: Use context information for conversations with LLMs.
9494

9595
### Outline

docs/backlog.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
# Backlog
22

33
## Iteration +1
4-
- Outline: Revisit `notes` in `cratedb-outline.yaml` about
5-
other resources that have not been expanded properly yet
6-
https://github.com/crate/about/issues/24
7-
- Outline: Explore using refined content representations by
8-
pulling in `ctk docs functions` and `ctk docs settings`
9-
- llms-txt: Compare sizes of CrateDB's `llms.txt` against sizes
4+
- Bundle: Compare sizes of CrateDB's `llms.txt` files against sizes
105
of other vendors. Adjust when needed.
116
https://github.com/crate/about/issues/20
127
- Bundle: `test_cli_bundle` is heavy, and may incur timeouts
8+
- Linter: YAML, Markdown, Linkchecker, Element sizes
139

1410
## Iteration +2
11+
- UI: Little chat interface using Streamlit
1512
- Any: JSON/YAML/Markdown output
1613
- Query: Let the user optionally select a local or remote `llms.txt` file
1714
- Query: Let the user select the model, reasoning effort, and other parameters
1815
- Outline: `find_items`: Include and/or exclude multiple sections
1916
- Outline: Refactor `--optional` flag to `--include=optional` option
17+
- Bundle: Don't let HTML leak into bundle files
2018

2119
## Iteration +3
20+
- Bundle: Explore using refined content representations by
21+
pulling in `ctk docs functions` and `ctk docs settings`
2222
- Outline: Unlock Discourse, auto-select https://community.cratedb.com/raw/1015
2323
- Outline: Unlock HTML resources, auto-convert using the best standalone program.
2424
=> https://www.urltoany.com/url-to-markdown
@@ -35,3 +35,8 @@
3535
=> Better provide a context manager interface right away?
3636
- Outline: Rename `CRATEDB_CONTEXT_URL` to `ABOUT_CONTEXT_URL`
3737
- Outline: Rename `OUTLINE_URL` to `ABOUT_OUTLINE_URL`
38+
- Outline: Is the built-in outline currently validated?
39+
- Bundle: README in HTML format
40+
- Inventory: Revisit `notes` in `cratedb-outline.yaml` about
41+
other resources that have not been expanded properly yet
42+
https://github.com/crate/about/issues/24

0 commit comments

Comments
 (0)