Skip to content

cratedb-about ask: Use location /about #10

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

Merged
amotl merged 3 commits into from
May 9, 2025
Merged

cratedb-about ask: Use location /about #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a5bf143
Documentation: Advertise to use https://cdn.crate.io/about/
amotl May 8, 2025
5e80750
Documentation: Add note about the `CRATEDB_CONTEXT_URL` env var
amotl May 8, 2025
8dc4930
Remove generated files from repository
amotl May 8, 2025
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
3 changes: 2 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@
.venv*
*.egg-info
*.lock
bdist.*
__pycache__
bdist.*
build/llm/*.txt
2 changes: 2 additions & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
## Unreleased
- Chore: Removed `sponge` command in `poe build`
- Content: Added two pieces of content from blog articles, converted to Markdown format
- Documentation: Started advertising to use the designated location
https://cdn.crate.io/about/ for consuming the generated resources

## v0.0.1 - 2025-04-17
- Established project layout
Expand Down
7 changes: 5 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ to relevant resources in the spirit of a curated knowledge backbone.
- The [cratedb-overview.md] file includes hints about what CrateDB is
and what you can do with it.

- The [build/llm] folder includes a few [llms.txt] files generated from
- The [about/v1] folder includes a few [llms.txt] files generated from
[cratedb-overview.md]. They can be used to provide better context
for conversations about CrateDB.

Expand All @@ -35,8 +35,11 @@ If you are running out of questions, get inspired by the standard library.
cratedb-about list-questions
```

To configure a different context file, use the `CRATEDB_CONTEXT_URL` environment
variable.

[build/llm]: ./build/llm

[about/v1]: https://cdn.crate.io/about/v1/
[CrateDB]: https://cratedb.com/database
[cratedb-overview.md]: ./src/index/cratedb-overview.md
[llms.txt]: https://llmstxt.org/
Loading