Docs: setup Mintlify docs for pg_stat_ch#47
Conversation
There was a problem hiding this comment.
Pull request overview
This PR initializes a Mintlify documentation site for pg_stat_ch, including site configuration, new onboarding pages, and styling/assets needed to publish and preview docs from the docs/ directory.
Changes:
- Add Mintlify site config (
docs/docs.json) and custom styling (docs/assets/styles.css) plus branding assets (logos + favicon). - Add new “Get started” pages and convert existing docs pages to use Mintlify frontmatter metadata.
- Update troubleshooting and hooks pages to use Mintlify components/formatting (
<Steps>, custom-rendered diagram).
Reviewed changes
Copilot reviewed 10 out of 13 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/pages/reference/version-compatibility.md | Adds Mintlify frontmatter metadata for the reference page. |
| docs/pages/reference/troubleshooting.mdx | Adds frontmatter and converts troubleshooting steps to Mintlify <Steps>/<Step> components. |
| docs/pages/reference/hooks.mdx | Adds frontmatter and adjusts the data-flow diagram rendering for consistent styling. |
| docs/pages/guides/testing.md | Adds Mintlify frontmatter metadata for the guide page. |
| docs/pages/guides/clickhouse.md | Adds Mintlify frontmatter metadata for the guide page. |
| docs/pages/get-started/quick-start.mdx | New Quick Start page using Mintlify <Steps>. |
| docs/pages/get-started/introduction.mdx | New Introduction page with a Mermaid diagram and internal navigation. |
| docs/docs.json | New Mintlify site configuration: theme, navigation, navbar links, and asset references. |
| docs/assets/styles.css | New custom CSS to align Mintlify UI with project branding (dark mode, code blocks, nav, callouts). |
| docs/assets/logo_light.png | Adds light-mode logo asset. |
| docs/assets/logo_dark.png | Adds dark-mode logo asset. |
| docs/assets/favicon.svg | Adds favicon asset with light/dark behavior. |
| docs/README.md | Adds instructions for running the docs locally. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| # pg_stat_ch docs | ||
|
|
||
| The pg_stat_ch documentation is built with [Mintlify](https://mintlify.com/) | ||
| and hosted at [TBD](TO DO) |
There was a problem hiding this comment.
The README includes a placeholder link ([TBD](TO DO)), which renders as a broken link in GitHub and is easy to forget to update. Replace this with the actual docs URL (once known) or remove the link until it’s available.
| and hosted at [TBD](TO DO) | |
| and hosted at TBD. |
docs/README.md
Outdated
| <CodeGroup> | ||
| ```bash npm theme={null} | ||
| npm i -g mint | ||
| ``` | ||
|
|
||
| ```bash pnpm theme={null} | ||
| pnpm add -g mint | ||
| ``` | ||
| </CodeGroup> |
There was a problem hiding this comment.
docs/README.md is plain Markdown, so the <CodeGroup> JSX and the extra code-fence metadata (theme={null}) won’t render on GitHub and will show up as literal text. Consider rewriting this section using standard Markdown (multiple headings / separate code blocks) so it reads correctly in the repository README.
iskakaushik
force-pushed
the
add-mintlify-docs
branch
from
a6e23af to
b61e78e
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 10 out of 13 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (1)
docs/pages/reference/hooks.mdx:173
- Switching from a fenced code block to a raw
<pre>with large inline styles removes Mintlify’s built-in code-block behaviors (syntax highlighting/copy button/theme consistency) and makes styling harder to maintain. Prefer keeping this as a fenced block (e.g., ```text) and handle centering/appearance via CSS classes inassets/styles.css(or a Mintlify-supported component) instead of inline styles.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This PR sets up the repository docs in a Mintlify site.
After installing the Mintlify CLI tool, you can run
mint devfrom the docs folder to preview the site locally.Once the additional deploy is provisioned for our org, we can install the Mintlify GitHub app and link it to this repository to deploy the docs site.