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

update doc documentation (lol) to properly run local server #677

Merged
merged 3 commits into from
Aug 8, 2023

Conversation

farazmsiddiqi
Copy link
Contributor

@farazmsiddiqi farazmsiddiqi commented Aug 8, 2023

Thank you for helping make the Radius documentation better!

Please follow this checklist before submitting:

  • Read the contribution guide
  • Commands include options for Linux, MacOS, and Windows within codetabs
  • New file and folder names are globally unique
  • [ x] Page references use shortcodes instead of markdown or URL links
  • [ x] Images use HTML style and have alternative text
  • [ x] Places where multiple code/command options are given have codetabs

In addition, please fill out the following to help reviewers understand this pull request:

Description

Updated the documentation that tells users how to run the doc local server. Previously, the local server instructions were not resulting in a running server for the user. So, I added an extra cd docsy step. Now, it is accurate.

Auto-generated description

🤖 Generated by Copilot at b38f65a

Summary

📁🎨🚀

Update instructions for installing and running the docs website locally. Add a step to change to the docsy directory before installing the theme dependencies.

docsy theme needs
dependencies installed
cut to its folder

Walkthrough

  • Add a command to switch to the docsy directory before installing theme dependencies and running the website locally (link)

Issue reference

@farazmsiddiqi farazmsiddiqi requested a review from a team as a code owner August 8, 2023 17:47
@github-actions
Copy link

github-actions bot commented Aug 8, 2023

Azure Static Web Apps: Your stage site is ready! Visit it here: https://wonderful-plant-020417a1e-677.westus2.azurestaticapps.net
Password: Radiu$1234

@AaronCrawfis AaronCrawfis enabled auto-merge (squash) August 8, 2023 20:36
@AaronCrawfis AaronCrawfis merged commit c15b21e into v0.23 Aug 8, 2023
7 of 8 checks passed
@AaronCrawfis AaronCrawfis deleted the farazmsiddiqi-patch-1 branch August 8, 2023 20:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants