Skip to content

Commit

Permalink
Update to the docs content to be @microsoft/fast-element specific (#…
Browse files Browse the repository at this point in the history
…6972)

# Pull Request

## 📖 Description

This update to the docs:
- Re-aligns docs around `@microsoft/fast-element`
- Adds more docs around the `html`, `css` and `FASTElement` exports  

## 👩‍💻 Reviewer Notes

There are 3 `TODO` marked documents that require separate PRs and reviews:
- DI (Dependency Injection)
- Migration (from `@microsoft/fast-element` v1 to v2) there may not be any breaking changes but there might be some suggestions for users looking to update their package
- Component library - with #6955 we are looking to assist the community in the creation of packages built on the `@microsoft/fast-element` package, this should provide some best practices and guidance on doing this.  

## ✅ Checklist

### General

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

- [ ] I have included a change request file using `$ yarn change`
- [ ] I have added tests for my changes.
- [x] 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

- Fill in the `TODO` docs in separate PRs
  • Loading branch information
janechu authored Jun 3, 2024
1 parent a789e14 commit 5eb926a
Show file tree
Hide file tree
Showing 33 changed files with 1,497 additions and 2,615 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Packages are located within the `packages` folder of the repository. Each packag
If you'd like to contribute by fixing a bug, implementing a feature, or even correcting typos in our documentation, you'll want to submit a pull request. Before submitting a pull request, be sure to [rebase](https://www.atlassian.com/git/tutorials/merging-vs-rebasing) your branch (typically from master) or use the *merge* button provided by GitHub.

:::note
For additional details on branch management, read the [branch guide](../community/branch-guide.md) documentation.
For additional details on branch management, read the [branch guide](./BRANCH_GUIDE.md) documentation.
:::

#### Change Files
Expand Down Expand Up @@ -118,7 +118,7 @@ If you are finding that your changes are either breaking changes or require mult

### Merging a pull request

If you are merging a pull request, be sure to use the pull request title as the commit title. The title should follow the [conventional commit guidelines](https://www.conventionalcommits.org/). It is recommended that if you are merging in pull requests regularly that you add a browser extension that will auto-correct the title for you. A few that should do this are [Refined GitHub](https://github.com/sindresorhus/refined-github) and [Squashed Merge Message](https://github.com/zachwhaley/squashed-merge-message).
If you are merging a pull request, be sure to use the pull request title as the commit title. The title should follow the [conventional commit guidelines](https://www.conventionalcommits.org/).

### Documenting breaking changes

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"type": "none",
"comment": "DevDependency update",
"packageName": "@microsoft/fast-react-wrapper",
"comment": "Update documentation site with 2.0.0 content",
"packageName": "@microsoft/fast-element",
"email": "[email protected]",
"dependentChangeType": "none"
}
230 changes: 0 additions & 230 deletions packages/web-components/fast-element/docs/guide/declaring-templates.md

This file was deleted.

Loading

0 comments on commit 5eb926a

Please sign in to comment.