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

Document using --template with other branch names #2413

Merged
merged 4 commits into from
Jan 20, 2023
Merged

Document using --template with other branch names #2413

merged 4 commits into from
Jan 20, 2023

Conversation

delucis
Copy link
Member

@delucis delucis commented Jan 19, 2023

What kind of changes does this PR include?

  • New or updated content

Description

@delucis delucis added the improve documentation Enhance existing documentation (e.g. add an example, improve description) label Jan 19, 2023
@delucis delucis self-assigned this Jan 19, 2023
@netlify
Copy link

netlify bot commented Jan 19, 2023

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 986b8bf
🔍 Latest deploy log https://app.netlify.com/sites/astro-docs-2/deploys/63cb0cfe9ac76b0008cac9ec
😎 Deploy Preview https://deploy-preview-2413--astro-docs-2.netlify.app/ar/install/auto
📱 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 settings.

Co-authored-by: Ohans Emmanuel <ohansemmanuel@outlook.com>
@sarah11918
Copy link
Member

Thanks for tackling this Chris, and trying to figure out what I'd prefer here:

  • update the command example to include #branch so there's only ONE long command, but mention that branch is only "other than main"
  • also have an example of the ASTRO templates themselves, which you can do just with --template blog vs --template withastro/astro#blog as these instructions would suggest (even though that's not the nice, all-purpose pattern).
  • instead of a paragraph, show multiple commands depending on what you want to open? An Astro template? Any repository you want? (and if so, maybe the "branch" becomes less important to point out, because it ends up being important for our repository, but we have a nice way of doing it?)

I honestly don't know what I want here! But, non-blocking, and def NWTWWHB! Will approve to get this in if we can't immediately think of something better. But I don't think this is what I'd like long-term as our approach here.

@delucis delucis merged commit e49d2de into main Jan 20, 2023
@delucis delucis deleted the chris/2372 branch January 20, 2023 22:08
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.

Wrong starter template description (and typo)
3 participants