Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 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
75 changes: 0 additions & 75 deletions .github/workflows/book.yml

This file was deleted.

21 changes: 21 additions & 0 deletions .github/workflows/trigger-deploy-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Trigger Aggregator Docs Rebuild

on:
push:
branches: [next]
Copy link
Collaborator

Choose a reason for hiding this comment

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

We probably want to only trigger this workflow if files in the docs directory change, no?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Absolutely agreed, will fix!


jobs:
notify:
runs-on: ubuntu-latest

permissions:
contents: read

steps:
- name: Send repository_dispatch to aggregator
uses: peter-evans/repository-dispatch@v3
Copy link
Collaborator

Choose a reason for hiding this comment

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

Let's pick a specific SHA revision of this action - depending on tags (which are mutable) is extremely risky when secrets are involved. We need to do this with our other uses, but I don't want to add any new GHA dependencies without selecting a revision that we've reviewed ourselves and vetted.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Absolutely agree with you on this one. I will pick a specific SHA ref and we can review it for safety.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

How about we plan on taking this SHA ref?: a628c95fd17070f003ea24579a56e6bc89b25766

It's the latest version that was released yesterday.

with:
# PAT (Personal Access Token) that grants permission to trigger the rebuild workflow at the docs repository
token: ${{ secrets.DOCS_REPO_TOKEN }}
repository: ${{ vars.DOCS_AGGREGATOR_REPO }}
event-type: rebuild
9 changes: 0 additions & 9 deletions docs/README.md

This file was deleted.

17 changes: 0 additions & 17 deletions docs/book.toml

This file was deleted.

3 changes: 3 additions & 0 deletions docs/external/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.docusaurus/
build/
node_modules/
31 changes: 31 additions & 0 deletions docs/external/docusaurus.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
import type { Config } from "@docusaurus/types";

// If your content lives in docs/src, set DOCS_PATH='src'; else '.'
const DOCS_PATH =
process.env.DOCS_PATH || (require("fs").existsSync("src") ? "src" : ".");

const config: Config = {
title: "Docs Dev Preview",
url: "http://localhost:3000",
baseUrl: "/",
trailingSlash: false,

// Minimal classic preset: docs only, autogenerated sidebars, same math plugins as prod
presets: [
[
"classic",
{
docs: {
path: DOCS_PATH, // '../docs' is implied because we are already inside docs/
routeBasePath: "/", // mount docs at root for quick preview
sidebarPath: "./sidebars.ts",
remarkPlugins: [require("remark-math")],
rehypePlugins: [require("rehype-katex")],
},
blog: false,
pages: false,
},
],
],
};
export default config;
Loading