Skip to content

WPManageNinja/fluent-community-developer-docs

Repository files navigation

Fluent Community Developer Documentation

Official developer documentation for the Fluent Community REST API.

📚 Documentation

Visit the documentation site: https://dev.fluentcommunity.co

🚀 Quick Start

Prerequisites

  • Node.js 18+ or compatible version
  • npm or pnpm

Installation

# Install dependencies
npm install

# Start development server
npm run docs:dev

# Build for production
npm run docs:build

# Preview production build
npm run docs:preview

📖 Documentation Structure

rest-api/
├── index.md              # API Overview
├── authentication.md     # Authentication Guide
├── getting-started.md    # Getting Started Guide
├── posts.md             # Posts API
├── comments.md          # Comments API
├── users.md             # Users API
├── spaces.md            # Spaces API
├── reactions.md         # Reactions API
├── media.md             # Media API
├── notifications.md     # Notifications API
├── bookmarks.md         # Bookmarks API
├── feeds.md             # Feeds API
├── search.md            # Search API
├── settings.md          # Settings API
├── errors.md            # Error Handling
├── examples.md          # Code Examples
└── changelog.md         # API Changelog

🛠️ Built With

  • VitePress - Static site generator
  • Vue 3 - Progressive JavaScript framework

📝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Adding New Documentation

  1. Create a new .md file in the appropriate directory
  2. Update .vitepress/config.mjs to add the page to navigation
  3. Follow the existing documentation style and format
  4. Test locally before submitting

📄 License

This documentation is licensed under MIT License.

🔗 Links

💬 Support

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5