Docs Directory in Openship: Location, Structure, and Integration

Yes, the Openship repository includes a top-level docs directory that stores all project documentation as Markdown/MDX files and powers the documentation website through the Fumadocs framework.

The oblien/openship codebase maintains its comprehensive documentation within a dedicated docs folder at the project root. This directory serves as the single source of truth for installation guides, edge-routing requirements, and internationalized content, while the Next.js web application consumes these files via the Fumadocs loader to render the public documentation site.

Locating the Docs Directory in Openship

The docs directory resides at the repository root alongside apps and packages. It contains the primary documentation files and assets that ship with the project:

• docs/installation.md – Primary setup instructions for deploying Openship
• docs/oblien-edge-routing-requirements.md – Technical specifications for edge routing configuration
• docs/screenshots/ – Image assets referenced in documentation pages (e.g., screen.png)
• docs/i18n/ – Locale-specific README files supporting multilingual documentation

Because the folder is part of the public source tree, you can access it directly via the GitHub web UI or raw content URLs without running the application locally.

How Openship Loads Documentation with Fumadocs

The web application (apps/web) consumes the docs directory through the Fumadocs framework configured in apps/web/src/lib/source.ts. The loader function initializes a documentation source that transforms Markdown files into queryable content served at the /docs base URL.

// apps/web/src/lib/source.ts
import { docs } from "@/.source/server";
import { loader } from "fumadocs-core/source";

export const docsSource = loader({
  baseUrl: "/docs",
  source: docs.toFumadocsSource(),
});

The loader configuration sets baseUrl: "/docs", which routes all documentation content to that path. The docs.toFumadocsSource() method processes the files from the root-level docs directory into a format the Next.js application can render dynamically.

Referencing the Docs Directory in the Openship UI

Navigation components within the landing page link directly to the documentation section using standard href attributes. In apps/web/src/components/landing/navbar.tsx, the docs are referenced via links pointing to /docs.

// apps/web/src/components/landing/navbar.tsx
// Navigation link referencing the docs directory
<a href="/docs" label="Docs" />

This integration ensures users can navigate from the marketing site directly into the Fumadocs-powered documentation section without leaving the application domain.

Documentation Structure and Key Files

The docs directory organizes content into logical units that support both local development and production deployments. According to the Openship source code, the folder contains:

• Installation Guides: docs/installation.md provides the primary setup workflow for new users
• Technical Specifications: Edge routing requirements live in docs/oblien-edge-routing-requirements.md
• Multilingual Support: The docs/i18n/ subdirectory contains localized README files (e.g., README.en.md, README.fr.md, README.de.md, README.ja.md)
• Visual Assets: The docs/screenshots/screen.png file supplies images used in quickstart tutorials

All files are standard Markdown or MDX, making them readable directly on GitHub or within the rendered web application.

Summary

• The oblien/openship repository includes a top-level docs directory containing Markdown/MDX documentation, images, and internationalized files.
• The Fumadocs loader in apps/web/src/lib/source.ts sources content from this directory using docs.toFumadocsSource() to generate the /docs route.
• Navigation links in apps/web/src/components/landing/navbar.tsx provide direct UI access to the documentation via href="/docs".
• Key files include docs/installation.md, docs/oblien-edge-routing-requirements.md, and localized READMEs under docs/i18n/.

Frequently Asked Questions

Where is the docs directory located in the Openship repository?

The docs directory resides at the root level of the oblien/openship repository, parallel to the apps and packages folders. You can view it directly in the GitHub web interface or access the files locally after cloning the repository.

What documentation framework does Openship use?

Openship uses Fumadocs to render documentation. The framework is configured in apps/web/src/lib/source.ts where the loader function imports content from the root-level docs directory and serves it at the /docs base URL within the Next.js application.

Can I read the Openship documentation without running the web application?

Yes. Because the docs directory contains standard Markdown files stored in the public GitHub repository, you can read the documentation directly on GitHub or via raw file URLs. Files such as docs/installation.md are fully readable without executing the Fumadocs loader.

Does Openship provide documentation in multiple languages?

Yes. The repository includes internationalized documentation within the docs/i18n/ subdirectory, which contains locale-specific README files for French, German, Japanese, and other languages. These files follow the naming convention README.{locale}.md.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}