More tweaks to docs content (#99)

* docs: update documentation content and fix link description in index.mdx

- Rephrased and expanded the pain points section with clearer descriptions
- Updated the demo link description for accuracy and consistency

* fix(docs): update import statements to use npm:@pgflow/dsl and correct wording in documentation

- Changed import paths from '@pgflow/dsl' to 'npm:@pgflow/dsl' for consistency
- Corrected wording in runtime restart note and UI descriptions for clarity
- Minor formatting adjustments for improved readability across multiple docs

* chore(docs): update multiple documentation pages with new instructions, terminal output examples,
and additional links

- Clarify SQL migration command with wildcard pattern
- Enhance terminal output examples for starting Edge Functions runtime and worker
- Add guidance on monitoring execution and viewing run status
- Include new links to related workflows and best practices in the final step section

* docs: update Flow DSL documentation to clarify input handling, type safety, and execution model

Enhanced explanations of the fluent API, the role of input.run, and type system features.
Refined examples demonstrating data flow, conditional logic, and JSON serialization guidelines.
Improved descriptions of step dependencies, parallelism, and separation of definition and
execution.

* docs: update flow DSL documentation with code snippets and explanations

- Correct code block formatting in the documentation
- Clarify examples of flow input, type safety, serializable step data, and dependencies
- Improve readability and consistency of the documentation content

* docs: update guide to manual configuration of flow options and clarify limitations

Refactor documentation to emphasize that pgflow's compiler does not support updating existing
flows,
and provide detailed instructions for manually modifying flow-level and step-level options
directly in the database.
Remove outdated sections and improve clarity on safe vs.
breaking changes, including examples for increasing retries.

* docs: add comprehensive guidelines on task design, reusability, and organization

- Updated flow-dsl documentation to emphasize functional programming practices for tasks
- Added a new "Create Reusable Tasks" guide detailing best practices for task parameters,
return types, documentation, and error handling
- Included examples of well-designed and poorly designed tasks
- Clarified the importance of JSON serialization and task organization strategies
- Enhanced guidance on organizing tasks and flows for maintainability and scalability

* docs: update documentation structure and content for clarity and consistency

- Corrected a typo in the "Next steps" section title
- Renamed "Organize Flows Codebase" to "Organize Flows code" for consistency
- Adjusted order values in sidebar metadata for better navigation
- Added missing titles and descriptions to some pages for completeness
- Renamed "organize-flows-codebase.mdx" to "organize-flows-code.mdx" to reflect the new naming
- Updated frontmatter to improve documentation organization and readability

* refactor: remove deprecated project status page and update configuration

- Deleted the 'Project Status' documentation page to streamline content
- Removed related configuration entries from astro.config.mjs
- Updated documentation to reflect current project focus and architecture plans

* docs: Update documentation structure, add new monitoring guide, and revise section ordering

- Renamed "Trigger and monitor flows" page title and improved description
- Replaced step state viewing instructions with a link to detailed monitoring guide
- Added new "Monitor flow execution" page with comprehensive SQL query examples
- Updated navigation order for "Create Reusable Tasks" and "Organize Flows code" sections
- Changed "Update Flow options" and "Version your Flows" sections order for consistency
- Minor formatting and structural improvements across docs for clarity and navigation

* fix: update documentation and configuration for workflow monitoring and flow options

- Corrected SQL queries for monitoring flow runs, step statuses, and task queues
- Clarified run status descriptions and error detail retrieval
- Improved workflow dependency visualization query
- Adjusted default values in flow options documentation for accuracy
- Fixed ordering in recent run queries and step status outputs
- Minor formatting and consistency improvements in docs

* docs: remove mention of runtime validation from configuration documentation

Author: jumski

pkgs/website/astro.config.mjs

@@ -81,14 +81,14 @@ export default defineConfig({
                 label: 'Getting Started',
                 autogenerate: { directory: 'getting-started/' },
               },
-              {
-                label: 'Explanations',
-                autogenerate: { directory: 'explanations/' },
-              },
               {
                 label: 'How To',
                 autogenerate: { directory: 'how-to/' },
               },
+              {
+                label: 'Explanations',
+                autogenerate: { directory: 'explanations/' },
+              },
             ],
           },
           {
@@ -110,11 +110,6 @@ export default defineConfig({
                 label: 'FAQ - Common Questions',
                 link: '/edge-worker/faq/',
               },
-              {
-                label: 'Project Status',
-                badge: { text: 'important', variant: 'caution' },
-                link: '/edge-worker/project-status/',
-              },
             ],
           },
           {

pkgs/website/src/content/docs/edge-worker/getting-started/configuration.mdx

@@ -22,8 +22,6 @@ EdgeWorker.start(console.log);
 
 :::caution[Configuration Validation]
 Currently, configuration options are not validated at runtime. Please double-check your settings carefully.
-
-Runtime validation is planned as part of the upcoming [configuration system improvements](/edge-worker/project-status/#planned-architecture-improvements).
 :::
 
 

pkgs/website/src/content/docs/edge-worker/getting-started/create-first-worker.mdx

@@ -29,11 +29,11 @@ Before starting, please read the [Install Edge Worker](/edge-worker/getting-star
     First, create a new Edge Function using the Supabase CLI. Then, replace its content with this code:
 
     ```typescript
-    import { EdgeWorker } from "jsr:@pgflow/edge-worker@0.0.4";
-    
+    import { EdgeWorker } from "jsr:@pgflow/edge-worker";
+
     EdgeWorker.start(async (payload: { url: string }) => {
       const response = await fetch(payload.url);
-    
+
       console.log("Scraped website!", {
         url: payload.url,
         status: response.status,
@@ -53,7 +53,7 @@ Before starting, please read the [Install Edge Worker](/edge-worker/getting-star
     your worker yet.
 
     :::note[Restarting Edge Runtime]
-    You must stop and start the Edge Runtime every time you make changes 
+    You must stop and start the Edge Runtime every time you make changes
     to your workers because of the `per_worker` policy.
     :::