Skip to content

Single page reference

Single Page Reference

Our documentation build process is designed to deliver consistent, accessible, and high-quality resources with every pull request. When a pull request is made, the gh-pages branch is updated and in addition four markdown files are compiled. This files consolidates all documentation, including API references, discussion forums, how-to guides, and tutorials. It is available for download from the pages branch: gh-pages/development/single_page_reference.

Key Use Cases

1. Offline Documentation

  • Accessibility: Users can download the comprehensive markdown file and access it without an internet connection.
  • Efficient Navigation: The single file format allows for complex keyword searches, enabling users to quickly locate the precise information they need without navigating through multiple documents.
  • Up-to-Date Information: With each pull request, the documentation is refreshed, ensuring that the offline version always reflects the latest changes and improvements.

2. Integration with Large Language Models

  • Retrieval Augmented Generation: The consolidated markdown file serves as the foundation for building a vector database that powers retrieval augmented generation systems. By converting the indexed content into embeddings, large language models can tap into a structured and comprehensive knowledge base, resulting in more precise and contextually relevant outputs.
  • For example, the Particula Assistant leverages this approach by using the single-page reference to deliver detailed information and guidance on aerosol particle simulation. This tool, hosted by OpenAI, requires a ChatGPT Plus account, and it exemplifies how specialized documentation can enhance the performance of advanced language models.

3. Code Development

  • Enhanced Context for Code Assistants: The rich content within the markdown file—including API details, guides, and tutorials—provides a valuable context for code assistants like GitHub Copilot, Kite, and CodeWhisperer. This helps these tools generate more precise code completions and contextual recommendations.
  • Improved Developer Workflow: By providing a comprehensive and current reference, the file assists code assistants in delivering accurate suggestions.