docs: update README to document new AI providers and features #1925
+121
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
docs: update README to document new AI providers and features
Summary
This PR revises the README documentation to thoroughly detail the addition of new AI providers, features, and tools to Fabric. The changes focus on improving discoverability and usability by documenting previously undocumented capabilities.
Files Changed
README.mdMajor documentation additions to cover:
generate_changelogtool documentationcmd/generate_changelog/incoming/1925.txtNew file containing changelog entry for this PR, following the project's changelog generation format; generated by the following command:
Code Changes
Table of Contents Updates
Added navigation links for new sections:
Supported AI Providers Section
Added a comprehensive list of 25+ supported AI providers, categorized into:
Dry Run Mode Documentation
Ollama Compatibility Mode
Documents the ability to use Fabric as an Ollama drop-in replacement with compatible API endpoints (
/api/tags,/api/chat,/api/version).Available Strategies
Document 10 prompt strategies with descriptions:
cot- Chain-of-Thoughtcod- Chain-of-Drafttot- Tree-of-Thoughtaot- Atom-of-Thoughtltm- Least-to-Mostself-consistent- Self-Consistencyself-refine- Self-Refinementreflexion- Reflexionstandard- Standardgenerate_changelog Tool
Documents the changelog generation tool with installation instructions and feature highlights.
Reason for Changes
generate_changelogtool lacked visibility in the main documentationImpact of Changes
Test Plan
--dry-run,--serve,--serveOllama)