Skip to content

Conversation

@itaismith
Copy link
Contributor

Description of changes

Flatten raw docs text files for easier access by Claude/ChatGPT

@propel-code-bot
Copy link
Contributor

propel-code-bot bot commented Jul 7, 2025

Flatten and Normalize Public TXT Documentation Files for LLM Access

This PR updates the handling and structure of public text-based documentation files to use flat, hyphen-separated, non-nested naming (e.g., public/llms-docs-overview-about.txt) for easier programmatic access by LLMs such as Claude and ChatGPT. Associated imports, prompt generation, and file loading logic in related TSX components are updated to match the new file organization. Additionally, a minor typo in a documentation code block is fixed.

Key Changes

• Standardizes public documentation text file paths from nested folders to flat, hyphen-separated naming
• Updates code in ask-ai.tsx and markdoc-renderer.tsx to generate and resolve file paths matching new naming convention
• Removes unnecessary imports and fixes a reference in the prompt logic
• Corrects typo in documentation code example: 'procees.env' to 'process.env'

Affected Areas

• docs/docs.trychroma.com/public/ (documentation .txt files)
• docs/docs.trychroma.com/components/markdoc/ask-ai.tsx
• docs/docs.trychroma.com/components/markdoc/markdoc-renderer.tsx

This summary was automatically generated by @propel-code-bot

@github-actions
Copy link

github-actions bot commented Jul 7, 2025

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

@itaismith itaismith merged commit c2df196 into main Jul 7, 2025
107 of 113 checks passed
Inventrohyder pushed a commit to Inventrohyder/chroma that referenced this pull request Aug 5, 2025
## Description of changes

Flatten raw docs text files for easier access by Claude/ChatGPT
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants