chore: prepare external mirror (README + PR template; remove dependabot)

github-actions[bot] · github-actions[bot] · commit 14d01d8aacf5 · 2025-11-12T12:27:50.000Z
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,24 +1,12 @@
-PR title should follow [Firebolt PR convention](https://packboard.atlassian.net/wiki/spaces/PACB/pages/3854237702/Firebolt+PR+Convention).
-Allowed types: build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test.
-
-Choose from one of the types above and set PR title to match `type[(scope)]: what changed (FIR-XXX)` format.
-
 # Description
 Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
 
-# When should this PR be released to the public?
-If the feature is live, the docs can be scheduled for **immediate release** by filing the PR to the gh-pages branch.
-If it's part of a **future release**, please file the PR against the corresponding release/packdb-<version> branch. 
-
-The preview URL will be available at https://firebolt-BRANCH.mintlify.app/ after the PR is created and built. `BRANCH` there is the name of your branch, in lowercase and with all special symbols except underscore replaced for dashes. E.g. `release/packdb-4.22` will be available at https://firebolt-release-packdb-4-22.mintlify.app/.
-
 # Documentation Checklist
 - [ ] I've previewed my documentation locally running `make start-local` 
 - [ ] I've validated that indexing works and that I'm able to navigate to the documentation page from the table of contents
 - [ ] If I added SQL examples, I have validated that they run correctly and as described. 
 
 If this PR touches a function implementation (aggregate, scalar, or table-valued):
-- [ ] I've made sure my documentation is aligned with [these](https://github.com/firebolt-analytics/firebolt-docs-staging/blob/gh-pages/.github/ISSUE_TEMPLATE/new-function-template.md) guidelines on function documentation 
+- [ ] I've made sure my documentation is aligned with [these](https://github.com/firebolt-db/godocs/blob/gh-pages/.github/ISSUE_TEMPLATE/new-function-template.md) guidelines on function documentation 
 - [ ] I've validated that the `parent` of my docs page is set correctly and the function shows up in the right category of the table of contents
 - [ ] I've made sure that the function was added to the function glossary
-
diff --git a/README.md b/README.md
@@ -1,31 +1,23 @@
 ## About this repo
 * This repository contains the source code for the Firebolt documentation (https://docs.firebolt.io/).
 * Pages are in [MDX format](#about-mdx-format-and-mintlify-platform).
-* Pages are hosted on [Mintlify](https://mintlify.com) platform. It offers [AI tooling](#ai-tools-in-mintlify), internal search and AI bot.
+* Pages are hosted on [Mintlify](https://mintlify.com) platform. It offers AI tooling, internal search and AI bot.
 * Main branch is `gh-pages`. It is automatically published to https://docs.firebolt.io/.
-* Main discussion channel is [#documentation](https://firebolt-analytics.slack.com/archives/C016HSVDP9U).
 * Important: To improve the search and AI bot, set great [keywords](https://mintlify.com/docs/pages#internal-search-optimization) and [description](https://mintlify.com/docs/pages#descriptions) as it influences search and AI bot functionality.
 
 ## Known problems
-* Mintlify sometimes doesn't generate previews for PRs. Check [here](#how-to-preview-remotely-in-mintlify) for workaround.
 * The crawler link checker sometimes would fail on a fetch timeout.
 
 ## Quick start
 * [Add a new page](#how-to-add-a-new-page).
 * [Run local checks](#how-to-check-locally) using `make check-all`.
 * [Preview the documentation locally](#how-to-preview-locally) using `make start-local`.
-* [Preview the documentation remotely on Mintlify](#how-to-preview-remotely-in-mintlify).
-* [Release changes](#how-to-release-changes).
-* [Make AI work for you](#how-to-use-ai-tools-to-edit-documentation).
+* [Contribute changes](#how-to-contribute-changes).
 
 ## Table of contents
 <!-- TOC -->
-  * [How to use AI tools to edit documentation](#how-to-use-ai-tools-to-edit-documentation)
-    * [Devin](#devin)
-    * [OpenAI Codex](#openai-codex)
   * [Guides for tooling](#guides-for-tooling)
     * [How to preview locally](#how-to-preview-locally)
-    * [How to preview remotely in Mintlify](#how-to-preview-remotely-in-mintlify)
     * [How to check locally](#how-to-check-locally)
       * [Merge conflict markers check](#merge-conflict-markers-check)
       * [Navigation structure check](#navigation-structure-check)
@@ -35,7 +27,7 @@
     * [How to add a new page](#how-to-add-a-new-page)
     * [How to move an existing page](#how-to-move-an-existing-page)
     * [How to add an interactive SQL example](#how-to-add-an-interactive-sql-example)
-    * [How to release changes](#how-to-release-changes)
+    * [How to contribute changes](#how-to-contribute-changes)
   * [Repository structure](#repository-structure)
   * [GitHub PR Workflow](#github-pr-workflow)
   * [About MDX format and Mintlify platform](#about-mdx-format-and-mintlify-platform)
@@ -45,43 +37,12 @@
     * [Further references](#further-references)
 <!-- TOC -->
 
-## How to use AI tools to edit documentation
-
-### Devin
-[@Devin](https://devin.ai/) is an autonomous AI agent that can handle simple tasks such as documentation changes.
-1. Tag [@devin](https://firebolt-analytics.slack.com/team/U08PTG2ADD3) in the App section of Slack or in a channel where it's added and give it a task.
-2. Ask [@devin](https://firebolt-analytics.slack.com/team/U08PTG2ADD3) for changes and improvements in PR comments or in the Slack thread.
-
-### OpenAI Codex
-[OpenAI Codex](https://chatgpt.com/codex) is an autonomous AI agent that can handle simple tasks such as documentation changes.
-![Example](images/openai-codex.png)
-1. Go to https://chatgpt.com/codex
-2. Pick the "firebolt-analytics/firebolt-docs-staging" environment.
-3. Describe the task.
-4. When the task is ready, click it.
-5. Choose the best variant and create a PR.
-6. Use the chat box in OpenAI Codex interface (the link to the task can be found in the PR description) to ask it for changes and improvements.
-
 ## Guides for tooling
 
 ### How to preview locally
 1. Run `make start-local`.
 2. Open http://localhost:3000/ in your browser to preview the documentation.
 
-### How to preview remotely in Mintlify
-NB: There's a know bug when Mintlify skips redeploying the PR preview even when new changes were pushed to [docs-mdx/](docs-mdx). Here's what their support says about it:
-> We've been able to investigate deeper and determined a few potential causes:
-> 1. The PR you added pictures for is pointing at branch release/packdb-4.24. We only trigger preview deployments for PRs pointing at a deployBranch, which in their case is gh-pages
-> 2. If the PR is opened with no changes to any docs content or docs.json, we won't create a preview deployment for it, which means any subsequent pushes to that PR won't update the preview deployment (because it doesn't exist)
-
-1. Open a PR in the repository. Make sure to:
-   * Have at lease some change in [/docs-mdx](/docs-mdx) directory. E.g. an insignificant change in a description of a page.
-   * Temporarily set the `gh-pages` branch as the destination branch of the PR. This is just to trigger a preview generation, and can be changed once the preview build job in the CI/CD pipeline starts.
-2. Wait for the CI/CD pipeline to run.
-   * This will build the documentation and deploy it to a remote preview environment using `Mintlify` special workflow.
-   * See the status of the deployment in the `Mintlify -> Mintlify Deployment` check in the pull request. There will be a link to the remote preview. ![Example](images/mintlify-deployment-check.png)
-3. Go to the preview by the link found in the build. The preview links are formed the following way: `https://firebolt-[your-branch-name-with-dashes].mintlify.app/` (e.g. `my_feature/new-page` has preview at `https://firebolt-my_feature-new-page.mintlify.app/`).
-
 ### How to check locally
 Use `make check-all` or just `make` to run all checks.
 
@@ -105,8 +66,8 @@ It runs the following subchecks:
   * `make check-links-using-crawler` to bring up a local site instance using `mint dev` and run [muffet](https://github.com/raviqqe/muffet) link crawler against it.
 
 #### SQL example check
-This checks that all `<QueryWindow/>` components in the documentation have pre-generated results that match the live Firebolt staging API results. See [here](#how-to-add-an-interactive-sql-example) on how to add a new interactive SQL example.
-* `make check-sql` to check that all `<QueryWindow/>` components when run against live Firebolt staging API produce expected results.
+This checks that all `<QueryWindow/>` components in the documentation have pre-generated results.
+* `make check-sql` to check that all `<QueryWindow/>` components produce expected results.
 * `make package-docs` to regenerate all results for all `<QueryWindow/>` components in the documentation.
 * `make package-missing-docs` to generate results for all `<QueryWindow/>` components that don't have pre-generated results.
 
@@ -120,8 +81,7 @@ This checks that all `<QueryWindow/>` components in the documentation have pre-g
 4. Add the file to the navigation structure in [docs-mdx/docs.json](docs-mdx/docs.json). **The navigation structure must reflect the directory structure.**
 5. Run the checks (`make check-all` or `make`) to ensure everything is correct and automatically update the [known_pages.json](known_pages.json) file with the new URL.
 6. Preview the page locally using `make start-local`.
-7. Push the changes to the repository and open the PR. See [here](#how-to-release-changes) for how to release the changes.
-8. Preview the results remotely (see how [here](#how-to-preview-remotely-in-mintlify)).
+7. Push the changes to the repository and open the PR. See [here](#how-to-contribute-changes) for how to contribute changes.
 
 ### How to move an existing page
 NB: `mint rename` does a terrible job, do not use it.
@@ -157,13 +117,13 @@ The interactive examples run against a dedicated Firebolt documentation server.
 4. Preview the page locally using `make start-local` to ensure the example works as expected.
 5. Further steps as similar to [adding a new page](#how-to-add-a-new-page).
 
-### How to release changes
-1. Open a pull request with the changes:
-   * Use `gh-pages` branch if the changes should be published right away.
-   * Use `release/packdb-X.YZ` branch (e.g. `release/packdb-4.24`) if the changes should be released with the next PackDB release.
-2. Wait for the CI/CD pipeline to run and the Mintlify [preview deployment](#how-to-preview-remotely-in-mintlify) to complete.
-3. The PR will appear in the [#documentation-prs](https://firebolt-analytics.slack.com/archives/C07H86T5R6U). Ask the owner team to review it.
-4. Merge the PR when it's approved. The changes will be automatically published either to https://docs.firebolt.io (for `gh-pages` branch) or to https://firebolt-release-packdb-X-YZ.mintlify.app (for `release/packdb-X.YZ` branch).
+### How to contribute changes
+1. Fork the repository to your GitHub account.
+2. Create a branch with your changes.
+3. Open a pull request with your changes to the `gh-pages` branch.
+4. Wait for the CI/CD pipeline to run and address any issues.
+5. The repository maintainers will review your PR and provide feedback.
+6. Once approved, the maintainers will merge your changes.
 
 ## Repository structure
 * [docs-mdx/](docs-mdx) contains all the MDX files for the documentation:
@@ -177,10 +137,9 @@ The interactive examples run against a dedicated Firebolt documentation server.
   * [scripts/check_lost_redirects.py](scripts/check_lost_redirects.py) checks that all known URLs (listed in [known_pages.json](known_pages.json)) either have a corresponding page in [docs-mdx/](docs-mdx) or a proper redirect in [docs-mdx/docs.json](docs-mdx/docs.json).
   * [scripts/check_sql_examples.py](scripts/check_sql_examples.py) checks that pre-generated results in `<QueryWindow/>` components are the same as the real results.
   * [scripts/check_merge_conflict_markers.sh](scripts/check_merge_conflict_markers.sh) checks that there are no Git merge conflict markers in the documentation files.
-* [hidden_pages.json](hidden_pages.json) contains all pages that are intentionally not included in the navigation. This is to prevent accidental hiding of pages by forgeting to add them to [docs-mdx/docs.json](docs-mdx/docs.json).
+* [hidden_pages.json](hidden_pages.json) contains all pages that are intentionally not included in the navigation. This is to prevent accidental hiding of pages by forgetting to add them to [docs-mdx/docs.json](docs-mdx/docs.json).
 * [known_pages.json](known_pages.json) contains all URLs that have ever existed in the documentation. This is used to check for lost redirects.
 * [function-template.mdx](function-template.mdx) is an example page.
-* [images/](images) contains images used in [README.md](README.md).
 
 ## GitHub PR Workflow
 
@@ -190,7 +149,6 @@ The [.github/workflows/pr-check.yml](.github/workflows/pr-check.yml) workflow ru
 * **check-broken-links**: Internal link validation using Mintlify
 * **check-links-using-crawler**: External link validation (informational, doesn't block merge)
 * **check-sql-examples**: SQL example validation (informational, doesn't block merge)
-* **Mintlify**: This job runs the Mintlify deployment workflow to build and deploy the documentation to a [remote preview](#how-to-preview-remotely-in-mintlify).
 
 ## About MDX format and Mintlify platform
 ### Key differences between MDX and MD formats
