Create optimizations-to-make-to-your-docs-for-llms#59
Merged
themattwilliams merged 17 commits intoRedocly:mainfrom Aug 14, 2025
Merged
Create optimizations-to-make-to-your-docs-for-llms#59themattwilliams merged 17 commits intoRedocly:mainfrom
themattwilliams merged 17 commits intoRedocly:mainfrom
Conversation
Contributor
Author
|
cc: @themattwilliams |
adamaltman
reviewed
Aug 10, 2025
…es, and semantic drift guidance - Add performance data section with research citations and metrics - Include context boxes explaining the technical rationale behind each optimization technique - Add comprehensive semantic drift monitoring section with practical guidance - Refine language to be more conversational and accessible - Add proper citations linking to academic research and industry sources - Improve article structure with better flow between sections
- Add complete frontmatter following blog conventions - Set header image to llm_optimization_funnel_final.png - Include SEO metadata and proper categorization - Configure for BlogPost template with author and date
- Replace 'documentation' and 'ai' with 'tech-writers' and 'api' - Use only categories defined in blog-metadata.yaml - This should fix the article not appearing in local blog listing
- Remove SEO image path that was preventing article from appearing in blog listing - Update description to be more concise and conversational - Article should now display properly in local blog environment
adamaltman
reviewed
Aug 14, 2025
Contributor
|
Enhanced the LLM documentation optimization article with research, adde technical context boxes explaining the rationale behind optimization techniques. Added comprehensive semantic drift monitoring guidance and refined some of the language to stay conversational while improving technical accuracy slightly. |
adamaltman
reviewed
Aug 14, 2025
Per adamaltman review feedback: removed mention of Redocly's llms.txt automation as it doesn't relate to the 'Mixed topics confuse AI chunking' heading.
adamaltman
reviewed
Aug 14, 2025
adamaltman
reviewed
Aug 14, 2025
adamaltman
reviewed
Aug 14, 2025
Co-authored-by: Adam Altman <adam@rebilly.com>
Co-authored-by: Adam Altman <adam@rebilly.com>
Co-authored-by: Adam Altman <adam@rebilly.com>
- Replace 2023 MLOps data with 2025 Stack Overflow Developer Survey statistics - Add current data: 84% of developers use/plan to use AI tools, 46% don't trust AI accuracy - Remove redundant 'Mixed topics confuse AI chunking' heading per feedback - Streamline content structure for better flow
themattwilliams
approved these changes
Aug 14, 2025
Contributor
themattwilliams
left a comment
themattwilliams
left a comment
There was a problem hiding this comment.
done with feedback improvements
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What/Why/How?
Article: Optimizations to make to your docs for LLMs (via ércule)