Skip to content

Add AI context guide for OnTrack#76

Open
lgr2002 wants to merge 1 commit into
thoth-tech:mainfrom
lgr2002:docs/add-ai-context-guide
Open

Add AI context guide for OnTrack#76
lgr2002 wants to merge 1 commit into
thoth-tech:mainfrom
lgr2002:docs/add-ai-context-guide

Conversation

@lgr2002
Copy link
Copy Markdown

@lgr2002 lgr2002 commented Apr 18, 2026

Description

Added a new AI context guide page to the OnTrack documentation site. This page provides structured project context for contributors using AI tools such as GPT and Claude.

The guide includes:

  • project summary
  • key repositories
  • tech stack
  • backend API overview
  • frontend feature context
  • development setup
  • development workflow
  • guidance on how to use the context with AI tools

This change was made to support the idea raised during standup about creating a practical context file that helps AI tools understand the system faster and reduce hallucinations.

Fixes # (issue)

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation (update or new)

How Has This Been Tested?

  • Ran the documentation site locally using npm run dev
  • Verified that the new page renders correctly in the Team section
  • Checked page structure, headings, and formatting in the local Astro/Starlight site

Testing Checklist

  • Tested in latest Chrome
  • Tested in latest Safari
  • Tested in latest Firefox

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have documented my code in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have requested a review from ... on the Pull Request

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 18, 2026

Deploy Preview for ontrackdocumentation ready!

Name Link
🔨 Latest commit b6f6d86
🔍 Latest deploy log https://app.netlify.com/projects/ontrackdocumentation/deploys/69e3c7097f888d0008507edc
😎 Deploy Preview https://deploy-preview-76--ontrackdocumentation.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@jmirchh75
Copy link
Copy Markdown
Contributor

jmirchh75 commented Apr 27, 2026

Looks good overall, however I would also include the "doubtfire-deploy" repo in the list, even thoug it's not directly used, as I believe it provides the deployment and environment configuration for the system. It will also give a more complete view of how OnTrack works, which might be helpful for AI? Maybe some further information can be added to reflect this in the file, if the repo is added to the list.

@anaghwadhwa123
Copy link
Copy Markdown

I agree with what Julian said last week. Maybe even worth putting the Development Setup instructions slightly higher for those who are unsure on how to run the environment. However, I do feel that it is slightly word-heavy, so you could cut down on some things that may not be absolutely required.

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.

3 participants