Skip to content

feat: container API docs#8281

Merged
sarah11918 merged 12 commits into4.9.0from
feat/container-api
May 22, 2024
Merged

feat: container API docs#8281
sarah11918 merged 12 commits into4.9.0from
feat/container-api

Conversation

@ematipico
Copy link
Copy Markdown
Member

@ematipico ematipico commented May 15, 2024 •
edited
Loading

Description (required)

This PR adds the first batch of documentation of the container APIs.

I added a new page in the reference called "Container API" and a new paragraph in the "Testing" section.

For Astro version: 4.9. See astro PR #11051.

@vercel
Copy link
Copy Markdown

vercel bot commented May 15, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 22, 2024 0:12am
docs-i18n 🔄 Building (Inspect) Visit Preview 💬 Add feedback May 22, 2024 0:12am

@astrobot-houston
Copy link
Copy Markdown
Contributor

astrobot-houston commented May 15, 2024 •
edited
Loading

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

Locale File Note
en guides/testing.mdx Source changed, localizations will be marked as outdated.
en reference/container-reference.mdx Source added, will be tracked.
en nav.ts Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@ematipico ematipico mentioned this pull request May 15, 2024
Merged
@sarah11918 sarah11918 added add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) minor-release For the next minor release; in the milestone, "merge queue" = approved for merging on release day. labels May 15, 2024
@sarah11918 sarah11918 added this to the 4.9.0 milestone May 15, 2024
sarah11918
sarah11918 reviewed May 17, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

Looks great @ematipico !

I mostly added some links throughout, and tried to add a bit of "glue" text on the reference page to explain things a little. But of course, I'm going to need you to make my "explanations" make perfect sense! 😅

See what you think about some of my suggestions below! (I think you'll find some are tiny fixes, some are repeated "let's use this format" so it's not really as much as it looks)

ematipico and others added 7 commits May 17, 2024 15:49
@ematipico @sarah11918
Apply suggestions from code review
e85c9de 
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
@ematipico @sarah11918
Apply suggestions from code review
da5b33b 
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
@ematipico @sarah11918
Apply suggestions from code review
9b83722 
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
@ematipico @sarah11918
Apply suggestions from code review
63e3e7c 
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
@ematipico @sarah11918
Apply suggestions from code review
67f5340 
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
@ematipico @sarah11918
Apply suggestions from code review
e5b2a41 
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
@ematipico
remove astro config
4a62ed3
sarah11918
sarah11918 reviewed May 20, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

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

So close with this one! I'm really loving how it turned out! Just one little thing I think was missed in applying suggestions (unless I'm wrong, so speak up!) and one example I'd like you to double and triple check, just to be sure!

src/content/docs/en/reference/container-reference.mdx

Use this option when your component needs a value for `Astro.params` in order to generate a single route dynamically.

```astro name="Card.astro"
Copy link
Copy Markdown
Member

@sarah11918 sarah11918 May 20, 2024

Choose a reason for hiding this comment

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

Just checking, will Astro.params usually be used by a file generating dynamic routes?

If so, does it make sense for maybe this title name to be of the style src/pages/[slug].astro ? And then, the test example would need to be updated. Can you double check this whole example to make sure it reflects a very common use case?

Copy link
Copy Markdown
Member Author

@ematipico ematipico May 20, 2024

Choose a reason for hiding this comment

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

Yeah, I think it makes more sense to use a file with a dynamic route

@ematipico @sarah11918
Update src/content/docs/en/reference/container-reference.mdx
0c6ab40 
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
@sarah11918 sarah11918 changed the base branch from main to 4.9.0 May 22, 2024 12:02
@sarah11918 sarah11918 merged commit 8a09935 into 4.9.0 May 22, 2024
@sarah11918 sarah11918 deleted the feat/container-api branch May 22, 2024 12:07
@sarah11918 sarah11918 mentioned this pull request May 22, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sarah11918 sarah11918 sarah11918 left review comments

Assignees

No one assigned

Labels

add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. merge-on-release Don't merge this before the feature is released! (MQ=approved but WAIT for feature release!) minor-release For the next minor release; in the milestone, "merge queue" = approved for merging on release day.

Projects

None yet

Milestone

4.9.0

Development

Successfully merging this pull request may close these issues.

3 participants

@ematipico @astrobot-houston @sarah11918