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 to the docs content to be @microsoft/fast-element specific #6972

Merged
merged 8 commits into from
Jun 3, 2024

Conversation

janechu
Copy link
Collaborator

@janechu janechu commented Jun 3, 2024

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 RFC: FAST Project Re-alignmentΒ #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

  • I have included a change request file using $ yarn change
  • I have added tests for my changes.
  • I have tested my changes.
  • I have updated the project documentation to reflect my changes.
  • I have read the CONTRIBUTING documentation and followed the standards for this project.

⏭ Next Steps

  • Fill in the TODO docs in separate PRs

@janechu janechu self-assigned this Jun 3, 2024
sites/website/sidebars.js Outdated Show resolved Hide resolved
@janechu janechu merged commit 5eb926a into master Jun 3, 2024
10 checks passed
@janechu janechu deleted the users/janechu/update-docs-content branch June 3, 2024 19:07
janechu added a commit that referenced this pull request Jun 10, 2024
…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
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.

3 participants