Skip to content

Commit

Permalink
docs: improve readme (#7042)
Browse files Browse the repository at this point in the history
<!---
Thanks for filing a pull request 😄 ! Before you submit, please read the following:

Search open/closed issues before submitting. Someone may have pushed the same thing before!

Provide a summary of your changes in the title field above.
-->

# Pull Request

## 📖 Description

Starting a local dev server for the website requires install and build in the root directory first. This change reflects that process.

### 🎫 Issues

<!---
* List and link relevant issues here.
-->

## 👩‍💻 Reviewer Notes

<!---
Provide some notes for reviewers to help them provide targeted feedback and testing.

Do you recommend a smoke test for this PR? What steps should be followed?
Are there particular areas of the code the reviewer should focus on?
-->

## 📑 Test Plan

<!---
Please provide a summary of the tests affected by this work and any unique strategies employed in testing the features/fixes.
-->

## ✅ Checklist

### General

<!--- Review the list and put an x in the boxes that apply. -->

- [x] I have included a change request file using `$ npm run change`
- [ ] I have added tests for my changes.
- [ ] I have tested my changes.
- [x] I have updated the project documentation to reflect my changes.
- [x] I have read the [CONTRIBUTING](https://github.com/microsoft/fast/blob/master/CONTRIBUTING.md) documentation and followed the [standards](https://github.com/microsoft/fast/blob/master/CODE_OF_CONDUCT.md#our-standards) for this project.

## ⏭ Next Steps

<!---
If there is relevant follow-up work to this PR, please list any existing issues or provide brief descriptions of what you would like to do next.
-->
  • Loading branch information
marchbox authored Dec 4, 2024
1 parent 9cd1fd0 commit 5079918
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
3 changes: 3 additions & 0 deletions sites/website/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,11 @@ This website is built using [Docusaurus](https://docusaurus.io/), a modern stati

## Installation

Run the following commands in the **root directory**:

```sh
npm ci
npm run build
```

## Local Development
Expand Down
2 changes: 1 addition & 1 deletion sites/website/src/docs/getting-started/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,4 +75,4 @@ Now that the "hello-world" custom web component has been defined, it can be incl

It's as simple as that!

Continue reading through the docs to understand all of the potential ways to use `@microsoft/fast-element` for your website or application.
Continue reading through the docs to understand all of the potential ways to use `@microsoft/fast-element` for your website or application.

0 comments on commit 5079918

Please sign in to comment.