Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation improvements and restructuring #4

Merged
merged 20 commits into from
Jan 24, 2025

Conversation

jumski
Copy link
Contributor

@jumski jumski commented Jan 23, 2025

Updated docs structure and content for better clarity and user experience. Main changes include:

  • Added Getting Started section with better navigation flow
  • Improved configuration docs with detailed explanations and warnings
  • Renamed "Prepare environment" to "Install Edge Worker"
  • Updated project status to Alpha from PoC
  • Added links validator plugin
  • Enhanced configuration examples and descriptions
  • Fixed navigation links and restructured sidebar
  • Added validation warnings and usage tips
  • Improved content formatting and readability

…ecision

Refine documentation for EdgeWorker configuration options:
- Enhance wording for better readability
- Update description of configuration defaults
- Clarify explanations for specific configuration parameters
- Improve formatting and technical precision of documentation notes
Add starlight-links-validator package to improve documentation link integrity and update
package dependencies
- Specify minimum Supabase CLI version (2.0.2)
- Improve clarity of installation instructions
Rename documentation pages and update related links across multiple files to reflect new page
title and slug for edge worker installation guide
Reorganize navigation items for edge worker section by converting
'Install Edge Worker' into a nested submenu with additional items
Copy link

nx-cloud bot commented Jan 23, 2025

View your CI Pipeline Execution ↗ for commit 86f79c3.

Command Status Duration Result
nx affected -t lint test build ❌ Failed 1m 42s View ↗

☁️ Nx Cloud last updated this comment at 2025-01-24 13:20:51 UTC

…figuration

Refined text to better explain default queue behavior and configuration options, making the
documentation more precise and user-friendly
Clarify steps for starting Edge Function and HTTP request process
Update note about Edge Runtime restart requirements
Copy link

cloudflare-workers-and-pages bot commented Jan 23, 2025

Deploying pgflow with  Cloudflare Pages  Cloudflare Pages

Latest commit: 86f79c3
Status: ✅  Deploy successful!
Preview URL: https://5839b8e9.pgflow.pages.dev
Branch Preview URL: https://improve-docs-here-and-there.pgflow.pages.dev

View logs

jumski added 11 commits January 23, 2025 21:31
Refine documentation for Edge Worker project:
- Change project status from "Advanced Proof of Concept" to "Alpha"
- Update code examples to use 'url' instead of 'urlToScrape'
- Add example output for worker execution
- Clarify API stability and future configuration changes
Add project status link and modify text formatting for Alpha stage warning
Refine instructions for starting an Edge Function and processing messages,
making the steps more precise and easier to understand
… note

Simplified documentation by removing redundant caution aside about retry delay configuration
…ntation

Change log output description from stdin to console for clarity
Refine project status notes for EdgeWorker, including:
- Clarify API stability expectations
- Add note about configuration structure changes
- Remove redundant sections
- Improve readability of project status description
Minor text refinements in Edge Worker setup instructions, including grammar corrections and
more precise language describing worker initialization and message processing
…otes

Add detailed caution sections explaining configuration nuances for edge worker polling intervals
and runtime validation, enhancing user understanding of critical configuration parameters
Enhance explanation of message visibility timeout with more detailed and clear guidance:
- Replaced generic caution note with specific example
- Clarified potential risks of duplicate message processing
- Added step-by-step explanation of how visibility timeout works
Restructure and expand documentation for EdgeWorker configuration options, including:
- Reorganized queue configuration section
- Added detailed explanations for visibilityTimeout
- Expanded sections on concurrency and connection settings
- Removed redundant content
- Added code examples for configuration options
Enhance documentation for edge worker project with:
- Detailed dependency injection implementation plans
- New section on configuration handling improvements
- Clarified architectural refactoring roadmap
@jumski jumski changed the title Improve docs here and there Documentation improvements and restructuring Jan 24, 2025
Remove local migration copy step and update documentation to reference GitHub raw file URL for
edge worker migration
@jumski jumski merged commit 4bc8b74 into main Jan 24, 2025
2 of 3 checks passed
@jumski jumski deleted the improve-docs-here-and-there branch January 24, 2025 14:20
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