Skip to content

docs: improve README and fix configuration reference#188

Merged
wcollins merged 3 commits intoitential:mainfrom
wcollins:docs/improve-readme-and-docs
Feb 27, 2026
Merged

docs: improve README and fix configuration reference#188
wcollins merged 3 commits intoitential:mainfrom
wcollins:docs/improve-readme-and-docs

Conversation

@wcollins
Copy link
Contributor

Description

Rewrites the README with a concise layout, embedded terminal GIF demos, and streamlined quick-start instructions. Also fixes a broken markdown link in the configuration reference.

Type of Change

  • Documentation update

Changes Made

  • Add terminal GIF demos (version, workflow, output formats) with VHS tape source files
  • Rewrite README with condensed layout, feature table, and GIF examples
  • Fix broken [Application Settings} markdown link in docs/configuration-reference.md

Testing

  • Verify GIFs render correctly in the README on GitHub
  • Verify the Application Settings link in docs/configuration-reference.md navigates correctly

Checklist

  • Code follows the project's style guidelines
  • Self-review of code has been performed
  • Commits follow conventional format
  • No secrets or credentials committed

@wcollins wcollins added the documentation Improvements or additions to documentation label Feb 26, 2026
@wcollins wcollins requested a review from privateip February 26, 2026 20:27
@wcollins wcollins merged commit b812344 into itential:main Feb 27, 2026
1 check passed
@wcollins wcollins deleted the docs/improve-readme-and-docs branch February 27, 2026 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants