Skip to content

rasheed-fabrichq/fabric-auto-release-notes-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

14 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

SecureAPI Documentation

This repository contains the product documentation for the SecureAPI platform.

πŸ“š Documentation

The documentation is automatically published to GitHub Pages:

πŸ”„ Auto-Update System

This repository is automatically updated when code changes are merged in the main codebase:

  1. Code PR merged in fabric-auto-release-note-creator-and-document-updater
  2. GitHub Action analyzes changes using Claude AI
  3. Documentation update PR is automatically created here
  4. Product manager reviews and merges the updates
  5. GitHub Pages publishes the updated documentation

πŸ“ Repository Structure

docs/
β”œβ”€β”€ index.md              # Documentation home page
β”œβ”€β”€ authentication.md     # Authentication guide
└── billing.md           # Billing and pricing guide

πŸš€ Local Development

To preview documentation locally:

# Clone the repository
git clone https://github.com/rasheed-fabrichq/fabric-auto-release-notes-docs.git
cd fabric-auto-release-notes-docs

# View the markdown files in your editor
# Or use a markdown previewer

πŸ€– Automated Updates

Documentation updates are managed by:

  • Source: Changes detected in code repository
  • Analysis: Claude AI compares code changes with current docs
  • Review: Human approval required before publishing
  • Publishing: GitHub Pages auto-deploys on merge to main

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors