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

Check into docs configuration to have docs in separate repo #739

Open
valadas opened this issue Aug 24, 2024 · 0 comments
Open

Check into docs configuration to have docs in separate repo #739

valadas opened this issue Aug 24, 2024 · 0 comments

Comments

@valadas
Copy link
Owner

valadas commented Aug 24, 2024

See documentation here https://www.npmjs.com/package/gh-pages

The idea is that if the module is in a private repository, publishing its documentation in that repository may be less than useful as we don't get a free public website to host those docs. But if I am reading the docs correctly, we could publish the docs to any other repository (for github-pages purposes of having free hosting).

When testing this, we need to also consider the implications of someone submitting a PR to fix some typo on the docs repository instead of the private code repository.

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