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

5.0.0 beta docs #9240

Merged
merged 356 commits into from
Dec 3, 2024
Merged

5.0.0 beta docs #9240

merged 356 commits into from
Dec 3, 2024

Conversation

delucis
Copy link
Member

@delucis delucis commented Aug 29, 2024

Description (required)

This is the WIP branch for the documentation changes for Astro v5, soon to be in beta.

Documentation may be incomplete, but feel free to use the deploy preview if you are trying out an early release of Astro v5: https://5-0-0-beta.docs.astro.build/

To do before merging

  • Remove / redirect added in 8b2b3eb
  • Remove v5 beta badge in site header added in 8e56929
  • Update the docgen script to point to the new location for configuration types in the Astro repo in frontmatter etc. And remove beta docgen workflow.
  • Revert editLink change made in b3dea25.
  • Disable Pagefind and enable the Search component override changed in ca7d812

Copy link

netlify bot commented Aug 29, 2024

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 44fede1
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/674ee6ba9f9975000824c249
😎 Deploy Preview https://deploy-preview-9240--astro-docs-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@astrobot-houston

This comment was marked as outdated.

@github-actions github-actions bot added the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Aug 29, 2024
@sarah11918
Copy link
Member

I created withastro/astro#11961 to fix the error messages broken links

astrobot-houston and others added 8 commits September 11, 2024 11:51
* Add loader reference to the beta docs

* Move integration info to integrations ref page

* Apply suggestions from code review

Co-authored-by: Luiz Ferraz <[email protected]>
Co-authored-by: Armand Philippot <[email protected]>

* Apply suggestions from code review

Co-authored-by: Armand Philippot <[email protected]>

* Changes from review

* Changes from review

* Extract DataEntry type

* Apply suggestions from code review

Co-authored-by: Armand Philippot <[email protected]>

* Sarah tiny nits

* sarah tiny edit

* Apply suggestions from code review

Co-authored-by: Sarah Rainsberger <[email protected]>

* Add usage example

* Update src/content/docs/en/reference/loader-reference.mdx

---------

Co-authored-by: Luiz Ferraz <[email protected]>
Co-authored-by: Armand Philippot <[email protected]>
Co-authored-by: Sarah Rainsberger <[email protected]>
- **Frequently changing content**: Generate individual pages without requiring a static rebuild of your site. This is useful when the content of a page updates frequently, for example displaying data from an API called dynamically with `fetch()`.

:::tip
On-demand server rendering in Astro, especially when combined with [view transitions](/en/guides/view-transitions/), provides a true app experience without the JavaScript overhead of a client-side, single-page application. Even highly dynamic, interactive apps are possible.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure if having both on-demand and server rendering should be the case. I guess we're doing this way so it's easier for people to say "oh, it's like SSR" -- but my feeling generally goes towards choosing one and keeping it to make things clear and straightforward, but sure it would make sense to mention at the start "On-demand rendering, similar to server-side rendering (SSR), yada yada yada"

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, as the most basic of content, I'm OK having this be a tiny bit more explicit/all-encompassing like this. I wouldn't do it often, but on the one page we're introducing our concepts, I think it's fine!

@@ -41,7 +41,7 @@ Astro's focus on content from its beginnings as a static site builder have allow

### Server-first

**Astro leverages [server-rendering](/en/basics/rendering-modes/) over client-side rendering in the browser as much as possible.** This is the same approach that traditional server-side frameworks -- PHP, WordPress, Laravel, Ruby on Rails, etc. -- have been using for decades. But you don't need to learn a second server-side language to unlock it. With Astro, everything is still just HTML, CSS, and JavaScript (or TypeScript, if you prefer).
**Astro leverages [server-rendering](/en/basics/rendering/) over client-side rendering in the browser as much as possible.** This is the same approach that traditional server-side frameworks -- PHP, WordPress, Laravel, Ruby on Rails, etc. -- have been using for decades. But you don't need to learn a second server-side language to unlock it. With Astro, everything is still just HTML, CSS, and JavaScript (or TypeScript, if you prefer).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did change server-rendering to not have a hyphen on the other page, but looks like we've been using it for a while, so pointing out I am not sure if that's grammatically correct.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! I will do a global search and check for this throughout!

@delucis delucis restored the 5.0.0-beta branch January 11, 2025 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5.0 For 5.0 stable release 5.0.0-beta glossary Community initiative to build an Astro glossary! i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!)
Projects
None yet
Development

Successfully merging this pull request may close these issues.