Skip to content

docs: split compilation docs into startup and manual compilation pages#537

Merged
jumski merged 1 commit intomainfrom
12-10-split_compilation_to_startup_and_manual_compilation_docs
Dec 10, 2025
Merged

docs: split compilation docs into startup and manual compilation pages#537
jumski merged 1 commit intomainfrom
12-10-split_compilation_to_startup_and_manual_compilation_docs

Conversation

@jumski
Copy link
Copy Markdown
Contributor

@jumski jumski commented Dec 10, 2025

Split Compilation Documentation into Startup and Manual Approaches

This PR reorganizes the compilation documentation by splitting it into two distinct concepts:

  1. Startup Compilation - The primary, recommended approach where flows are automatically compiled when workers start
  2. Manual Compilation - The HTTP-based approach for explicit compilation in CI/CD workflows

Changes include:

  • Created new /concepts/startup-compilation/ page focusing on the automatic compilation workflow
  • Created new /concepts/manual-compilation/ page for the HTTP-based compilation approach
  • Added deprecation notices for manual compilation, indicating it may be removed in future releases
  • Updated navigation links in the sidebar to reflect the new structure
  • Added redirects from the old /concepts/compilation/ path to the new pages
  • Updated all references throughout the documentation to point to the appropriate new pages

This change better reflects the recommended workflow where most users rely on startup compilation, while still documenting the manual approach for teams with specific CI/CD needs.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Dec 10, 2025

⚠️ No Changeset found

Latest commit: 320c9ce

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Copy Markdown
Contributor Author

jumski commented Dec 10, 2025

@nx-cloud
Copy link
Copy Markdown

nx-cloud Bot commented Dec 10, 2025

View your CI Pipeline Execution ↗ for commit 320c9ce

Command Status Duration Result
nx affected -t verify-exports --base=origin/mai... ✅ Succeeded <1s View ↗
nx affected -t build --configuration=production... ✅ Succeeded <1s View ↗
nx affected -t lint typecheck test --parallel -... ✅ Succeeded 2s View ↗

☁️ Nx Cloud last updated this comment at 2025-12-10 16:57:03 UTC

Copy link
Copy Markdown
Contributor Author

jumski commented Dec 10, 2025

Merge activity

  • Dec 10, 4:51 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Dec 10, 4:56 PM UTC: Graphite rebased this pull request as part of a merge.
  • Dec 10, 4:57 PM UTC: @jumski merged this pull request with Graphite.
  • Dec 10, 4:58 PM UTC: A user started a stack merge that includes this pull request via Graphite.

@jumski jumski changed the base branch from 12-10-docs_update_for_auto-compilation_and_automatic_worker_management to graphite-base/537 December 10, 2025 16:52
@jumski jumski changed the base branch from graphite-base/537 to main December 10, 2025 16:54
@jumski jumski force-pushed the 12-10-split_compilation_to_startup_and_manual_compilation_docs branch from b57e43d to 320c9ce Compare December 10, 2025 16:55
@jumski jumski merged commit 4489f8e into main Dec 10, 2025
12 checks passed
@github-actions
Copy link
Copy Markdown
Contributor

🔍 Preview Deployment: Website

Deployment successful!

🔗 Preview URL: https://pr-537.pgflow.pages.dev

📝 Details:

  • Branch: 12-10-split_compilation_to_startup_and_manual_compilation_docs
  • Commit: 568846f03a6f06e234dc4dfa30952c23f9648099
  • View Logs

_Last updated: _

@github-actions
Copy link
Copy Markdown
Contributor

🚀 Production Deployment: Website

Successfully deployed to production!

🔗 Production URL: https://pgflow.dev

📝 Details:

  • Commit: 4489f8e2fd09178bad6dfeeea997bf0c0fb04aaa
  • View Logs

Deployed at: 2025-12-10T17:57:34+01:00

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant