docs(weave): Add TS to Cookbooks sidebar and scripts to convert TS files into MD files for render in docs #3370
+2,759
−22
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ash0ts
changed the title
|
Preview this PR with FeatureBee: https://beta.wandb.ai/?betaVersion=147a1d9b8b0ea6dbbf7a80a2502fb23710760589 |
ash0ts
changed the title
J2-D2-3PO
requested changes
Jan 10, 2025
docs/docs/reference/generated_typescript_docs/intro-notebook.md
Outdated
Show resolved
Hide resolved
J2-D2-3PO
approved these changes
Jan 10, 2025
|
@ash0ts looks like docs team can now approve changes, but it would probably be a good idea to get someone from @wandb/weave-team to take a look |
jamie-rasmussen
approved these changes
Jan 11, 2025
| ``` | ||
|
|
||
| ```typescript | ||
| function stripUserInput(userInput: string): string { |
There was a problem hiding this comment.
This is duplicating the code above?
| expected: "I write well" | ||
| }, | ||
| { | ||
| userInput: "GPT-4 is smartest AI model.", |
There was a problem hiding this comment.
We might want to consider changing this example to avoid the appearance of having favorites :-)
| @@ -293,7 +390,7 @@ On a high-level the steps to create custom Scorer are quite simple: | |||
|
|
|||
| </TabItem> | |||
| <TabItem value="typescript" label="TypeScript"> | |||
| ```plaintext | |||
| ```typescript | |||
There was a problem hiding this comment.
I wouldn't change this until there is code here - it will cause unwanted syntax highlighting of keywords.
| }, | ||
| "keywords": [], | ||
| "author": "", | ||
| "license": "ISC", |
| } | ||
| } | ||
|
|
||
| main(); |
There was a problem hiding this comment.
Should end files with trailing newline
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes:
Added TypeScript examples and documentation generation scripts.
Updated sidebars.ts to include TypeScript documentation.
Created scripts for generating TypeScript markdown docs from .ts files.
Added example TypeScript project configuration (tsconfig.json) and dependencies.