Skip to main content

Create a Doc, But Faster

If at any point you need a deeper explanation, see the pages above in the sidebar.

Prerequisites​

  • Node.js >=18, Yarn (Classic), and Git installed. See Requirements if not.

Get the code​

External contributors — fork, then clone your fork:

Fork the Repository

git clone https://github.com/<your-username>/pan.dev.git

Internal contributors (org members) — clone the main repo directly:

git clone https://github.com/PaloAltoNetworks/pan.dev.git

Set up and start​

cd pan.dev
yarn
git checkout -b <feature-branch>
yarn start

Create the doc​

touch products/<product>/docs/tutorials/new-doc.mdx

Add frontmatter with a unique id:

products/<product>/docs/tutorials/new-doc.mdx
---
id: new-doc-id
title: New Doc
sidebar_label: New Doc
---

Wire it into the sidebar​

Edit the product's sidebar (products/<product>/sidebars.ts):

products/<product>/sidebars.ts
module.exports = {
  contributing: [
    {
      type: "category",
      label: "Tutorials",
      items: ["contributing/tutorials/api", "contributing/tutorials/new-doc-id"],
    },
  ],
};

Author and commit​

Add your Markdown below the frontmatter, then:

git add .
git commit -m "Add new tutorial: <topic>"
git push origin <feature-branch>

Open a pull request​

The output of git push includes a "Create a pull request for '<branch>' on GitHub by visiting…" link. Visit it, add details, and click Create Pull Request.

Check the deploy preview​

Once the PR is open, CI builds a Firebase Hosting preview and runs automated checks (Playwright, link checks, etc.). The preview URL and check results are posted to the PR.