Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Deploy Docusaurus to GitHub Pages

on:
push:
branches:
- main

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Use Node.js 22.x
uses: actions/setup-node@v4
with:
node-version: 22.x
cache: npm

- name: Install dependencies
run: npm ci

- name: Build Docusaurus site
run: npm run docusaurus:build

- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./build

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
22 changes: 22 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,24 @@
node_modules
.idea

# Docusaurus
.docusaurus/
build/

# Additional Node.js ignores
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# OS
.DS_Store
Thumbs.db

# IDE
.vscode/
*.swp
*.swo

# Logs
logs/
*.log
70 changes: 70 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
const { themes } = require("prism-react-renderer");
const lightCodeTheme = themes.github;
const darkCodeTheme = themes.dracula;

// With JSDoc @type annotations, IDEs can provide config autocompletion
/** @type {import('@docusaurus/types').DocusaurusConfig} */
module.exports = {
title: "IPA - Improvement Proposal for APIs",
url: "https://go.mongodb.org", // Your website URL
Copy link
Collaborator

@drinkbird drinkbird Jul 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this the correct URL? I saw the comment in the description.

Could we temporarily use the GitHub Pages native URL?

baseUrl: "/",
onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
favicon: "img/favicon.ico",
organizationName: "mongodb",
projectName: "ipa", // Usually your repo name.
presets: [
[
"classic",
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
path: "ipa", // Use ipa/ as docs root
routeBasePath: "/", // Serve docs at site root
sidebarPath: require.resolve("./sidebars.js"),
editUrl: undefined,
},
blog: false,
theme: {},
}),
],
],

themeConfig:
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
navbar: {
title: "IPA - Improvement Proposal for APIs",
items: [
{
href: "https://github.com/mongodb/ipa",
label: "GitHub",
position: "right",
},
],
},
footer: {
style: "dark",
links: [
{
title: "Documentation",
items: [
{
label: "General Guidelines",
to: "/1",
},
{
label: "SDK Guidelines",
to: "/900",
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} MongoDB, Inc. Built with Docusaurus.`,
},
prism: {
theme: lightCodeTheme,
darkTheme: darkCodeTheme,
},
}),
};
2 changes: 1 addition & 1 deletion ipa/general/0100.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ This includes but is not limited to:

The MongoDB Style Guide uses the Merriam-Webster’s Collegiate Dictionary. 11th
ed. Springfield, MA: Merriam-Webster, 2003. Continually updated at
<https://www.merriam-webster.com/>.
[https://www.merriam-webster.com/](https://www.merriam-webster.com/).

## Further Reading

Expand Down
2 changes: 2 additions & 0 deletions ipa/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
id: index
sidebar_position: 1
slug: /
---

# Improvement Proposal for APIs (IPA)
Expand Down
Loading