Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 73 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,73 @@
# .github-private
# .github-private

## Documentation Publishing Services

This repository contains the **Documentation Publishing Services** - an intermediary service system that brings coherence, uniformity, and provides a better managed knowledge base platform for brand-endorsed documentation.

### Features

- πŸ“ **Universal Documentation Publishing** - Publish documentation from any format to brand-endorsed platforms
- βœ… **Validation & Quality Assurance** - Automated validation ensuring documentation meets brand standards
- πŸ”„ **Format Transformation** - Convert between multiple documentation formats seamlessly
- 🎨 **Brand Consistency** - Apply brand-specific styling and guidelines automatically
- πŸ€– **Automation Ready** - GitHub Actions workflows for CI/CD integration
- πŸ“Š **Multi-Brand Support** - Manage documentation for multiple brands from one system

### Quick Start

See the [Documentation Publishing Service README](./docs-publishing-service/README.md) for complete documentation.

#### Publishing a Document

```bash
curl -X POST https://api.docs-publishing.example.com/v1/publish \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"source": "path/to/document.md",
"brand": "your-brand",
"category": "guides"
}'
```

#### Using GitHub Actions

```yaml
name: Publish Documentation
on:
push:
paths: ['docs/**']

jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: ./docs-publishing-service/workflows/publish-action
```

### Documentation

- πŸ“– [Main Documentation](./docs-publishing-service/README.md)
- πŸ—οΈ [Architecture Overview](./docs-publishing-service/ARCHITECTURE.md)
- πŸ”Œ [API Reference](./docs-publishing-service/api/README.md)
- βš™οΈ [Configuration Guide](./docs-publishing-service/config/README.md)
- πŸ“‹ [Templates](./docs-publishing-service/templates/README.md)
- πŸ”„ [Workflows](./docs-publishing-service/workflows/README.md)
- πŸ’‘ [Examples](./docs-publishing-service/examples/README.md)

### Repository Structure

```
.github-private/
β”œβ”€β”€ docs-publishing-service/
β”‚ β”œβ”€β”€ api/ # API specifications
β”‚ β”œβ”€β”€ config/ # Configuration files
β”‚ β”‚ └── brands/ # Brand-specific configs
β”‚ β”œβ”€β”€ templates/ # Documentation templates
β”‚ β”œβ”€β”€ workflows/ # GitHub Actions workflows
β”‚ β”œβ”€β”€ examples/ # Usage examples
β”‚ β”œβ”€β”€ README.md # Service documentation
β”‚ └── ARCHITECTURE.md # Architecture details
β”œβ”€β”€ README.md # This file
└── LICENSE
Loading