Skip to content
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

Jump to bottom

Mention strip-tags and symbex and ttok in the documentation #111

Closed
simonw opened this issue Jul 16, 2023 · 5 comments
Closed

Mention strip-tags and symbex and ttok in the documentation #111

simonw opened this issue Jul 16, 2023 · 5 comments
Labels
documentation Improvements or additions to documentation
Milestone
0.8

Comments

@simonw
Copy link
Owner

simonw commented Jul 16, 2023 •
edited
Loading

The documentation should include some of the neat things you can do with them.

Maybe in a new "cookbook" section.
@simonw simonw added the documentation Improvements or additions to documentation label Jul 16, 2023
@simonw simonw added this to the 0.6 milestone Jul 16, 2023
@simonw
Copy link
Owner Author

simonw commented Jul 16, 2023

Maybe a recipes.md page shown directly after usage.md with recipes - or "Tools and recipes".

@simonw
Copy link
Owner Author

simonw commented Jul 16, 2023

Diátaxis suggests the term "how-to guides". I'm torn between that, cookbook and recipes.

@simonw
Copy link
Owner Author

simonw commented Jul 16, 2023

OpenAI call their version of this the Cookbook: https://github.com/openai/openai-cookbook

@simonw simonw modified the milestones: 0.6, 0.8 Aug 18, 2023
@simonw
Copy link
Owner Author

simonw commented Aug 20, 2023

These are linked to from blog posts on the index page, that's good enough for the moment: https://llm.datasette.io/

@simonw simonw closed this as completed Aug 20, 2023
@simonw
Copy link
Owner Author

simonw commented Aug 21, 2023

I can do better than that though. I'll at least have a "related tools" section.

@simonw simonw reopened this Aug 21, 2023
@simonw simonw closed this as completed in 1212cc9 Aug 21, 2023
simonw added a commit that referenced this issue Aug 21, 2023
@simonw
Release 0.8
ebe2e08 
Refs #111, #147, #153, #154, #155, #158, #160, #167, #173, #174
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.8
Development

No branches or pull requests
1 participant
@simonw