Problem/Motivation

The documentation for this project now lives on the Varbase docs site: https://docs.varbase.vardot.com/developers/understanding-varbase/varbase-ai-recipes/varbase-ai-context.

The README repeats that documentation at length and does not link the docs page, so the two drift apart.

Steps to reproduce

  1. Open README.md on the 1.0.x branch.
  2. It does not link the docs page above.

Proposed resolution

  • Keep README.md short: a Documentation link near the top, the install commands, and links to the docs page instead of the removed files.
  • Add one line to AGENTS.md and CHANGELOG.md (Unreleased).

Remaining tasks

  • ✅ File an issue
  • ❌ Addition/Change/Update/Fix
  • ❌ Testing to ensure no regression
  • ➖ Automated unit/functional testing coverage
  • ❌ Developer Documentation support
  • ❌ User Guide Documentation support
  • ➖ UX/UI designer responsibilities
  • ➖ Accessibility and Readability
  • ❌ Reviewed by a human
  • ❌ Code review by maintainers
  • ❌ Full testing and approval
  • ❌ Credit contributors
  • ❌ Review with the product owner
  • ❌ Update Release Notes
  • ❌ Release

User interface changes

  • N/A

API changes

  • N/A

Data model changes

  • N/A

Release notes snippet

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

rajab natshah created an issue. See original summary.

  • rajab natshah committed 6b091f61 on 1.0.x
    docs: #3633017 Move the documentation to docs.varbase.vardot.com
    
rajab natshah’s picture

Status: Active » Fixed

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.