docs: remove toc from first tool guide and add unique ids to markdown headers #580
Conversation
njhale
requested review from
drpebcak,
thedadams,
StrongMonkey and
iwilltry42
|
|
||
| ```text | ||
| > **Note:** `*` is a wild card pattern that applies the metadata to all Tools in a `tool.gpt`. |
There was a problem hiding this comment.
There is a "callout" for things like this.
| > **Note:** `*` is a wild card pattern that applies the metadata to all Tools in a `tool.gpt`. | |
| :::note | |
| `*` is a wild card pattern that applies the metadata to all Tools in a `tool.gpt`. | |
| ::: |
There was a problem hiding this comment.
Is this valid markdown, or is it mdx? These files are automatically fetched at build time from the example repos; in this case https://github.com/otto8-ai/python-hash-tool/blob/main/README.md, so it's nice to stick to GitHub compatible markdown if we can.
|  | ||
|
|
||
| ### Using The `Hash` Tool in an Agent | ||
| 1. <details> |
There was a problem hiding this comment.
Curious why we need HTML instead of Markdown?
There was a problem hiding this comment.
HTML gives us better control the size and position of the images in this document. In this case I'm also using <details> to keep them hidden until the user clicks on the step, greatly reducing visual clutter.
If there's a better way to do this without HTML, I'm all ears.
| const FILE_URLS = [ | ||
| 'https://raw.githubusercontent.com/otto8-ai/python-hash-tool/main/README.md', | ||
| 'https://raw.githubusercontent.com/njhale/python-hash-tool/main/README.md', |
There was a problem hiding this comment.
Is this an expected change?
There was a problem hiding this comment.
nope! this was leftover from testing, thank you for catching that.
| @@ -62,6 +64,25 @@ async function fetchFiles(outputDir: string) { | |||
| ); | |||
| } | |||
|
|
|||
| // Function to add unique IDs to Markdown headers | |||
| function addUniqueHeaderIds(url, markdown: string): string { | |||
There was a problem hiding this comment.
Why is this necessary? Can we just add the IDs directly?
There was a problem hiding this comment.
This makes it easier for folks to fetch and use Markdown from any repo together without having to make changes to those repos to make the IDs unique.
Also, the syntax to add these IDs is mdx, so any IDs would render in GitHub's markdown preview:
njhale
force-pushed
the
docs/remove-toc-from-first-tool-guide
branch
3 times, most recently
from
fd65a71 to
2bdfb49
Compare
headers - The default table of contents is incompatible with tabs, so remove it from the first-tool guide - Auto-generated IDs for markdown headers in the first-tool page aren't unique, so generate unique IDs and inject them at snippet fetch time - Re-fetch latest README.md files from `*-hash-tool` repos to fix guide doc formatting issues Signed-off-by: Nick Hale <[email protected]>
njhale
force-pushed
the
docs/remove-toc-from-first-tool-guide
branch
from
2bdfb49 to
c7b97db
Compare
from the first-tool guide
unique, so generate unique IDs and inject them at snippet fetch time
*-hash-toolrepos to fixguide doc formatting issues