Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add compass docs skeleton #279

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Add compass docs skeleton #279

wants to merge 3 commits into from

Conversation

billytrend-cohere
Copy link
Collaborator

@billytrend-cohere billytrend-cohere commented Dec 3, 2024

This PR introduces a new Compass platform, which is a sample Pet Store Server based on the OpenAPI 3.0 specification. It provides a comprehensive API reference and documentation, including guides and concepts.

The PR adds the following new files:

  • fern/compass/compass-openapi.yaml: This file contains the OpenAPI specification for the Pet Store Server, including server details, API information, and various API paths.
  • fern/compass/compass.yml: This file defines the structure of the Compass platform, including tabs for documentation and API reference, a landing page, and navigation settings.
  • fern/compass/guides/compass-guide.mdx: This file contains the content for the Compass guide, including a title, slug, and description.

Additionally, the PR updates the fern/docs.yml file to include a new version named "Cohere Compass", which points to the fern/compass/compass.yml file.

@billytrend-cohere billytrend-cohere requested review from a team as code owners December 3, 2024 14:17
@billytrend-cohere billytrend-cohere marked this pull request as draft December 3, 2024 14:17
Copy link

github-actions bot commented Dec 3, 2024

Copy link

Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants