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

Docs: Hydrate App options are lacking documentation #736

Open
fromkeith opened this issue May 18, 2021 · 0 comments
Open

Docs: Hydrate App options are lacking documentation #736

fromkeith opened this issue May 18, 2021 · 0 comments

Comments

@fromkeith
Copy link

Page: https://stenciljs.com/docs/hydrate-app

Options for HYDRATEDOCUMENT and RENDERTOSTRING only show types and no additional documentation on what each option does.

stencil/src/declarations/stencil-public-compiler.ts provides comments on each option.

Proposed: Submit a pull request copying over the comments from the TypeScript file for each option into the documentation file src/docs/guides/hydrate-app.md. Reformat to a table instead of a list for each option

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

No branches or pull requests

1 participant