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

new install and setup page #8415

Merged
merged 10 commits into from
Jun 3, 2024
Merged

new install and setup page #8415

merged 10 commits into from
Jun 3, 2024

Conversation

sarah11918
Copy link
Member

@sarah11918 sarah11918 commented May 31, 2024

Description (required)

This PR is in advance prep for sidebar reorg PR #8239 and attempts to provide more a more complete picture of "getting started" with a new project (without being overly long or overwhelming). The intention is to set users up for success on this one page, vs needing to click several pages before they are actually working successfully on their project.

It creates a new page to eventually replace the Auto Install page (and manual page) to include:

  • manual installation, as well as installation starting from a theme (as before this was misleading since you can't do it AFTER installing Astro)
  • very quick explanation of how to get started and work in dev mode, including the dev toolbar
  • quick mention of build/preview/deploy so that people can very early on, before they mess up a blank project too much, ensure that they have a working foundation
  • calls attention to the Configuration section that WILL be removed from the sidebar re: configuration (e.g. TypeScript, Editor Config etc.) as a next step. These items will now be easier to see, and recommended up front as "setup" immediately after "install"

This PR separates out the new content from the sidebar nav changes that will happen later.

Notably, this does NOT perform all the housekeeping tasks like deleting the manual install page, moving anything out of the sidebar that is now mentioned on this page etc. It's just to keep the "big" sidebar PR to minimum content changes, and allow the translators to translate content separately!

Copy link

vercel bot commented May 31, 2024

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 Jun 3, 2024 10:21pm
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
docs-i18n ⬜️ Ignored (Inspect) Jun 3, 2024 10:21pm

@sarah11918 sarah11918 mentioned this pull request May 31, 2024
5 tasks
@astrobot-houston
Copy link
Contributor

astrobot-houston commented May 31, 2024

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 install-and-setup.mdx Source added, will be tracked.
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.

@sarah11918 sarah11918 added the improve documentation Enhance existing documentation (e.g. add an example, improve description) label May 31, 2024
Copy link
Contributor

@rgilsimoes rgilsimoes left a comment

Choose a reason for hiding this comment

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

Just dropped some suggestions.

@sarah11918
Copy link
Member Author

Thank you @rgilsimoes ! You've identified some areas that could be improved for sure! I am taking some of these suggestions and there's one I'll have to think a little harder about, since I think it probably needs a bit more of a rewrite! 🙌

Co-authored-by: Ricardo Jaime Gil Simões <ricardo.gil.simoes@gmail.com>
Copy link
Member

@yanthomasdev yanthomasdev left a comment

Choose a reason for hiding this comment

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

Just a few small comments, otherwise LGTM!

src/content/docs/en/install/auto.mdx Outdated Show resolved Hide resolved
src/content/docs/en/install/auto.mdx Outdated Show resolved Hide resolved
src/content/docs/en/install/auto.mdx Outdated Show resolved Hide resolved
src/content/docs/en/install/auto.mdx Outdated Show resolved Hide resolved
src/content/docs/en/install/auto.mdx Outdated Show resolved Hide resolved
src/content/docs/en/install/auto.mdx Outdated Show resolved Hide resolved
src/content/docs/en/install/auto.mdx Outdated Show resolved Hide resolved
Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
@sarah11918 sarah11918 merged commit f7c12aa into main Jun 3, 2024
8 checks passed
@sarah11918 sarah11918 deleted the install-and-setup-together branch June 3, 2024 22:32
ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Jun 27, 2024
* Translate install-and-setup.mdx (added in withastro#8415) in French
ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Jun 27, 2024
* Translate install-and-setup.mdx (added in withastro#8415) in French
yanthomasdev added a commit that referenced this pull request Jun 27, 2024
* i18n(fr): add install-and-setup.mdx

* Translate install-and-setup.mdx (added in #8415) in French

* i18n(fr): fix anchor links referring to install-and-setup.mdx

Some French pages uses anchors in the `install-and-setup` page. Since
I have translated the page, the anchors was broken.

---------

Co-authored-by: Yan <61414485+yanthomasdev@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improve documentation Enhance existing documentation (e.g. add an example, improve description)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants