bump-sh / docs

Content hub for Bump.sh
https://docs.bump.sh
Other
2 stars 12 forks source link

Create Content Hub Structure #2

Closed ChristopheDujarric closed 11 months ago

ChristopheDujarric commented 1 year ago

I'd like to have the main landing page of the content hub route users to various sections. Like on Docusaurus' site image

Sections:

A design like https://rapidapi.com/learn for the main landing page would be great. The same design for our own /hub/tutorials so that we can dispatch people to tutorials focused on OpenAPI, or on AsyncAPI, or on generic API knowledge would be great. Each section will have its own sidebar/table of contents.

Projected structure:

Content Hub Landing                 # Global landing page design
├── Bump.sh API reference.          # Ideally integrated from Bump.sh
├── Help Center
│   └── What is Bump.sh?
│   ├── Specifications support      # Doc group in the table of content, not an actual page (see Gitbook)
│   │   └── AsyncAPI support
│   │   └── OpenAPI support
│   │   └── Polymorphism
│   ├── Getting up and running.     # Doc group
│   │   └── Bump.sh CLI
│   │   └── Continuous Integration
│   │     └── GitHub Action
│   │   └── API Change Management
│   │     └── WebHooks
│   │   └── Branching
│   │   └── References
│   │   └── Hubs
│   ├── Customizing your docs      # Doc group
│   │   └── Set a customer domain
│   │   └── Meta images
│   │   └── Markdown support
│   ├── Configuring access         # Doc group
│   │   └── Organizations
│   │     └── Single Sign-On (SSO)
│   │   └── Access Management
├── API Guides                      # Global landing page design
│   └── API Basics
│   │   └── Introduction
│   │   └── The Best API Documentation Tools for Dev Teams
│   │   └── A Developer's Guide to API First Design
│   │   └── Creating Better API Architecture Diagrams
│   └── OpenAPI
│   │   └── Introduction
│   │   └── Building a REST API with OpenAPI and Typescript
│   │   └── Using OpenAPI Tags to Better Organize API Endpoints
│   │   └── Using OpenAPI Tags to Better Organize API Endpoints
│   │   └── Building an ExpressJS API with OpenAPI
│   │   └── Using OpenAPI Security schemes to describe your API authentication
│   └── AsyncAPI
│   │   └── Introduction
│   │   └── AsyncAPI Example: Building Your First Event-Driven API
│   │   └── AsyncAPI vs. OpenAPI: Deciding Which Specification is Right for Your App
│   │   └── AsyncAPI + Websocket Example Application
│   │   └── AsyncAPI + Kafka Example Application
└── Changelog

In a later step, the Content Hub could also gather the catalog of public APIs imported to Bump.sh as a dedicated section:

Content Hub Landing                 
├── Bump.sh API reference.
├── Help Center
├── Tutorials
├── Public APIs Catalog           # Specific landing page design focused on API doc search
└── Blog
antlio commented 1 year ago

Do we plan to move the blog content to the hub too or just displaying a link to the /blog

In case we do let's be careful about the SEO here since I'd advocate that it's better to keep it to the main website root level, to be validated 👍

paulRbr commented 1 year ago
  • the blog (already imported in #1

What do you mean by “already imported”?