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

Configure GitHub Pages workflows for publishing docs #1845

Open
Tracked by #1832
MajorLift opened this issue Oct 16, 2023 · 0 comments
Open
Tracked by #1832

Configure GitHub Pages workflows for publishing docs #1845

MajorLift opened this issue Oct 16, 2023 · 0 comments
Labels

Comments

@MajorLift
Copy link
Contributor

MajorLift commented Oct 16, 2023

As we migrate libraries into the core monorepo, we want to preserve and/or migrate existing typedoc sites published under the metamask.github.io domain using GitHub Pages workflows.

  • To achieve this, we may need to configure GitHub Pages workflows for publishing typedocs for all packages in core.
  • We may want to use a /core namespace for docs published from the core monorepo.
MajorLift added a commit that referenced this issue Oct 16, 2023
…er migration.

- Add links to github pages docs once it's set up in core.
  - See #1845
MajorLift added a commit that referenced this issue Oct 16, 2023
## Explanation

- Removes content in `eth-json-rpc-provider` README that is no longer
relevant due to its migration as a non-root package in the monorepo.
- During future migrations, this step should be performed while the
package is in `merged-packages/`.
- TODO: Restore links to GitHub Pages docs once the `publish-docs`
workflows are set up in core.
  - See #1845

## References

- Closes #1846

## Changelog

### `@metamask/eth-json-rpc-provider`

- **CHANGED**: Removed outdated README contents.

## Checklist

- [ ] I've updated the test suite for new or updated code as appropriate
- [ ] I've updated documentation (JSDoc, Markdown, etc.) for new or
updated code as appropriate
- [ ] I've highlighted breaking changes using the "BREAKING" category
above as appropriate
@MajorLift MajorLift self-assigned this Oct 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant