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

Modify suggestion to change output to 'server' on HTML Form Recipe #10876

Open
JakeHadley opened this issue Feb 3, 2025 · 1 comment
Open
Labels
help wanted Issues looking for someone to run with them! improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes)

Comments

@JakeHadley
Copy link

📚 Subject area/topic

Recipes

📋 Page(s) affected (or suggested, for new content)

https://docs.astro.build/en/recipes/build-forms/

📋 Description of content that is out-of-date or incorrect

The page suggests that output should be changed to server to render a form on the page.

🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)

No response

@sarah11918
Copy link
Member

Thank you! This is indeed "older wording" that needs to be updated:

Image

  1. We don't use the phrase "SSR mode" anymore. We refer to a page (individually) as being "rendered on demand" or not (prerendered/static). It is no longer necessary to server render ALL your pages in order to have one page with a form rendered on demand.
  2. We almost never want to suggest that someone change their output to 'server' anymore. The exception is when someone is creating a highly-dynamic app and they probably DO want EVERY page rendered on demand, with maybe some static pages as the exception. Astro's default 'static' mode will do just fine for most people, who instead probably want one of the following options depending on their specific use case:
    • an individual page server rendered.
    • a server island to defer the rendering of a component.
    • a client (framework) island on an Astro page

To fix this:

  • The opening paragraph needs to change to something like: "Astro pages that are rendered on demand can both display and handle forms"
  • The prerequisites needs to change to something like: "An Astro project with a server adapter installed."

This would be a great first issue for anyone who would like to make a PR! 🙌

@sarah11918 sarah11918 added improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes) help wanted Issues looking for someone to run with them! labels Feb 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Issues looking for someone to run with them! improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes)
Projects
None yet
Development

No branches or pull requests

2 participants