General contributing maintenance - #579
Conversation
github-actions
Bot
added
langchain
There was a problem hiding this comment.
Pull Request Overview
This PR performs general maintenance on the documentation repository by updating Copilot instructions for better reviews, reorganizing conceptual guides into a new /oss/concepts directory, and adding information about code language fences to the README.
- Update GitHub Copilot instructions with improved folder structure and style guide information
- Move conceptual guides (Memory, Context, Subgraphs) to
/oss/conceptsdirectory and update all cross-references - Add documentation about custom code language fences to README
Reviewed Changes
Copilot reviewed 19 out of 21 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| .github/copilot-instructions.md | Update folder structure documentation and add style guide information |
| README.md | Add section on custom code language fences and improve formatting |
| src/oss/learn.mdx | Update links to conceptual guides in new /concepts directory |
| src/oss/contributing/documentation.mdx | Update example page links to new conceptual guide locations |
| src/oss/concepts/context.mdx | Update internal cross-references to memory guide |
| Multiple LangGraph files | Update cross-references to subgraphs and memory guides in new locations |
| Multiple LangGraph Platform files | Update cross-references to memory and subgraphs guides |
| src/oss/langchain/agents.mdx | Update memory guide reference |
|
Preview ID generated: preview-copilo-1758209315-e7fbcac |
Kathryn May (katmayb)
left a comment
Kathryn May (katmayb)
left a comment
There was a problem hiding this comment.
Just had one question about code block docs syntax depending on OSS / Commercial docs. But otherwise LGTM!
| We have implemented custom code language fences for Python and Javascript. They are used to tag content that is specific to that language. Use either `:::python` or `:::js` to tag content that is specific to that language. Both are closed with the `:::` fence. | ||
|
|
||
| If any code fences like this exist on the code page, then two outputs (one for each language) will be created. For example, if this syntax is on the page in `/concepts/foo.mdx`, two pages will be created at `/python/concepts/foo.mdx` and `/javascript/concepts/foo.mdx`. |
There was a problem hiding this comment.
I don't know if this is only referring to the OSS docs, but is it confusing that in LangSmith / Platform we're using CodeGroup even though there are often Python / JavaScript code blocks for examples (rather than wanting two separate files).
There was a problem hiding this comment.
I think ideally, we use CodeGroup and keep one set of docs. The custom language fences are more because the prose / descriptions are also different (not just code samples). I'll clarify here that we only use this fencing in OSS docs
There was a problem hiding this comment.
OK cool, thanks!
|
Preview ID generated: preview-copilo-1758213608-d8f406a |
Overview
/oss/conceptsdir and update cross-referencesType of change
Type: Update existing docs
Related issues/PRs
Checklist
docs devsrc/docs.jsonif neededAdditional notes