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

Integrate RSocket javadocs into website #14

Open
DavidMGross opened this issue Mar 15, 2019 · 1 comment
Open

Integrate RSocket javadocs into website #14

DavidMGross opened this issue Mar 15, 2019 · 1 comment

Comments

@DavidMGross
Copy link
Collaborator

A canonical source of RSocket javadocs will be helpful for answering support questions and for links from other, task-oriented documentation pages.

@jell-o-fishi
Copy link
Member

Thoughts:

  1. This should be extended to other implementation (e.g. python, javascript)
  2. Each language usually has it's own source to documentation complier
  3. The look and feel of these compliers are very visually different
  4. Simply placing the output of these compilers would make the site look and feel inconsistent

I don't think this documentation should be embedded in the site. Maybe just a consistent method of linking to external documentation ? In the python guide I intend to simply link to rsocket.readthedocs.io when I want to reference API documentation.

Thoughts ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants