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

[DOC] - Create a static documentation site based on Readthedocs #75

Closed
francis-du opened this issue Mar 14, 2020 · 6 comments
Closed

[DOC] - Create a static documentation site based on Readthedocs #75

francis-du opened this issue Mar 14, 2020 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@francis-du
Copy link
Member

Description :

  • Create a static documentation site based on Readthedocs.
  • Support markdowm documents with the Recommonmark module.
  • Automatically triggering builds with Readthedocs' webhook.
  • Use Readthedocs to bind our custom domain, such as doc.oss.chat.
@francis-du
Copy link
Member Author

@huan Hi Huan,please assign this issue to me,thanks.

@huan
Copy link
Collaborator

huan commented Mar 14, 2020

Thank you very much for adding the docs to our project.

It would be better if we can use the basic and naive Markdown format, with the GitHub Pages, instead of a new Python system. (if it is a must to set up a system for the docs, I'd like to prefer the JavaScript ecosystem because our project is based on javascript.)

Anyway, it's a great start for us to have the documentation pages!

@huan huan added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 14, 2020
@francis-du
Copy link
Member Author

GitHub Pages depends on Jekyll.Jekly relies on Ruby again.
I think Readthedocs configuration is easier for developers.
I don't know if there are other platforms or tools for JavaScript.

@huan
Copy link
Collaborator

huan commented Mar 14, 2020

Jekyll is acceptable because it's a naive GitHub Pages solution. ;-)

There's no JavaScript solution as far as I know, so let's start from the Readthedocs version(it's good), and let's see if we can move to the GitHub Pages Jekyll version in the future.

I appreciate your efforts for the docs, and have a nice day!

@francis-du
Copy link
Member Author

Readthedocs has many good features, such as multi-version management, multi-language support,etc...

@lijiarui
Copy link
Collaborator

lijiarui commented Apr 2, 2020

Cool!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants