Skip to content

Commit 72871d6

Browse files
playground documentation (#1)
1 parent 0104292 commit 72871d6

File tree

8 files changed

+18329
-541
lines changed

8 files changed

+18329
-541
lines changed

README.md

Lines changed: 5 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,4 @@
1-
# Docus i18n Starter
2-
3-
> A beautiful, internationalized starter for creating multi-language documentation with Docus
4-
5-
This is the i18n Docus starter template that provides everything you need to build beautiful, multi-language documentation sites with Markdown and Vue components.
6-
7-
## ✨ Features
8-
9-
- 🌍 **Internationalization** - Native i18n support for multi-language docs
10-
- 🎨 **Beautiful Design** - Clean, modern documentation theme
11-
- 📱 **Responsive** - Mobile-first responsive design
12-
- 🌙 **Dark Mode** - Built-in dark/light mode support
13-
- 🔍 **Search** - Full-text search functionality per language
14-
- 📝 **Markdown Enhanced** - Extended markdown with custom components
15-
- 🎨 **Customizable** - Easy theming and brand customization
16-
-**Fast** - Optimized for performance with Nuxt 4
17-
- 🔧 **TypeScript** - Full TypeScript support
1+
# TwigBush Docs
182

193
## 🚀 Quick Start
204

@@ -26,13 +10,9 @@ npm install
2610
npm run dev
2711
```
2812

29-
Your multilingual documentation site will be running at `http://localhost:3000`
13+
The site will be running at `http://localhost:3000`
3014

31-
## 🌍 Languages
3215

33-
This starter comes pre-configured with:
34-
- 🇺🇸 **English** (`en`) - Default language
35-
- 🇫🇷 **Français** (`fr`) - French translation
3616

3717
## 📁 Project Structure
3818

@@ -79,28 +59,12 @@ content/
7959
The i18n starter generates URLs with language prefixes:
8060

8161
- English: `/en/getting-started/installation`
82-
- French: `/fr/getting-started/installation`
8362
- Default locale fallback: `/getting-started/installation` (redirects to English)
8463

85-
## ⚡ Built with
86-
87-
This starter comes pre-configured with:
88-
89-
- [Nuxt 4](https://nuxt.com) - The web framework
90-
- [Nuxt Content](https://content.nuxt.com/) - File-based CMS
91-
- [Nuxt i18n](https://i18n.nuxt.com/) - Internationalization
92-
- [Nuxt UI Pro](https://ui.nuxt.com/pro) - Premium UI components
93-
- [Nuxt Image](https://image.nuxt.com/) - Optimized images
94-
- [Tailwind CSS 4](https://tailwindcss.com/) - Utility-first CSS
95-
- [Docus Layer](https://www.npmjs.com/package/docus) - Documentation theme
96-
97-
## 📖 Documentation
98-
99-
For detailed documentation on customizing your Docus project, visit the [Docus Documentation](https://docus.dev)
10064

101-
## 🚀 Deployment
65+
## Deployment
10266

103-
Build for production:
67+
Create build
10468

10569
```bash
10670
npm run build
@@ -110,4 +74,4 @@ The built files will be in the `.output` directory, ready for deployment to any
11074

11175
## 📄 License
11276

113-
[MIT License](https://opensource.org/licenses/MIT)
77+
[MIT License](https://opensource.org/licenses/MIT)

content/en/1.getting-started/2.introduction.md

Lines changed: 4 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ navigation:
55
icon: i-lucide-book-open
66
seo:
77
title: Introduction to TwigBush
8-
description: Learn about TwigBush, a production-ready GNAP implementation for secure, key-bound access control
8+
description: Learn about TwigBush
99
---
1010

1111
## What is TwigBush?
1212

13-
TwigBush is a production-ready implementation of the [Grant Negotiation and Authorization Protocol (GNAP, RFC 9635)](https://www.rfc-editor.org/rfc/rfc9635.html) written in Go. It provides a complete **Authorization Server (AS)** and supporting libraries for **Resource Servers (RS)**, enabling modern, cryptographically-bound access control for both human users and AI agents.
13+
TwigBush is an early open source implementation of the [Grant Negotiation and Authorization Protocol (GNAP, RFC 9635)](https://www.rfc-editor.org/rfc/rfc9635.html) written in Go. It provides the foundation for a **GNAP Authorization Server (AS)** and supporting libraries for **Resource Servers (RS)**, enabling modern, key-bound access control for both human users and AI agents. We’re building this project in the open to grow a community around secure, next-generation authorization.
1414

1515
## Why GNAP?
1616

@@ -92,38 +92,16 @@ The server starts on port **8085** by default. Verify it's running:
9292
curl http://localhost:8085/.well-known/jwks.json
9393
```
9494

95-
### Configuration
96-
97-
TwigBush uses environment variables for configuration:
98-
99-
```bash
100-
# Server Configuration
101-
GNAP_PORT=8085
102-
GNAP_HOST=localhost
103-
104-
# Database
105-
DATABASE_URL=postgresql://user:pass@localhost/gnap
106-
107-
# Policy Engine
108-
OPENFGA_ENABLED=true
109-
OPENFGA_URL=http://localhost:8080
110-
111-
# Token Settings
112-
TOKEN_TTL=300 # seconds
113-
TOKEN_ISSUER=https://as.example.com
114-
```
11595

11696
## Next Steps
11797

11898
- [GNAP Concepts](/en/concepts/gnap-protocol) - Understand GNAP fundamentals
119-
- [Authorization Server Setup](/en/guides/authorization-server) - Deploy your AS
120-
- [Resource Server Integration](/en/guides/resource-server) - Protect your APIs
121-
- [Policy Configuration](/en/guides/policy-engine) - Configure access policies
99+
- [Playground Demo](/en/guides/playground) - Try the interactive GNAP grant lifecycle
122100

123101
## Contributing
124102

125103
We welcome contributions! See our [Contributing Guide](https://github.com/TwigBush/TwigBush/blob/main/CONTRIBUTING.md) for details.
126104

127105
## License
128106

129-
TwigBush is released under the [Apache License 2.0](https://github.com/TwigBush/TwigBush/blob/main/LICENSE).
107+
TwigBush is released under the [Apache License 2.0](https://github.com/TwigBush/TwigBush/blob/main/LICENSE).

content/en/2.concepts/1.gnap-protocol.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,4 @@ DPoP: eyJ0eXAiOiJkcG9w...
253253

254254
## Next Steps
255255

256-
- [Authorization Server Setup](/en/guides/authorization-server) - Deploy TwigBush AS
257-
- [Client Implementation](/en/guides/gnap-client) - Build GNAP clients
258-
- [Security Best Practices](/en/guides/security) - Production deployment guide
256+
- [Experiment with the GNAP Playground](/en/guides/playground)

0 commit comments

Comments
 (0)