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

Documentation hosting #39

Open
acrisci opened this issue Apr 4, 2019 · 1 comment
Open

Documentation hosting #39

acrisci opened this issue Apr 4, 2019 · 1 comment

Comments

@acrisci
Copy link
Member

acrisci commented Apr 4, 2019

I'm not really sure the best way to do this. There is no equivalent of something like read-the-docs for jsdoc projects.

Github Pages will work well for this but I don't like the idea of putting compiled documentation in this repository.

On dbus-next, I've decided to use a separate doc repository that will be shared for my projects which contains the project documentation:

https://github.com/acrisci/doc

Which is then hosted here:

https://acrisci.github.io/doc/node-dbus-next/

But there is a manual update step when the project releases.

How do you think we should do this?

@emersion
Copy link
Collaborator

emersion commented Apr 4, 2019

Hmm. I'm not a fan of creating a dedicated repo for the docs, I'd rather just use a branch.

Additionally I have a emersion.github.io → emersion.fr redirect in place. Gah. Maybe I should just kill the redirection.

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

2 participants