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

Provide embedded documentation #80

Merged
merged 1 commit into from
Jan 27, 2021
Merged

Conversation

angelozerr
Copy link
Collaborator

Provide embedded documentation

Fixes #35

Signed-off-by: azerr [email protected]

@angelozerr
Copy link
Collaborator Author

This PR provides

  • online vscode-kafka documentation

image

  • offline vscode-documentation .

KakaEmbedDocDemo

The content of the doc must be improved a lot but the mechanism is done. The following idea is to bind documentation from the settings to the embed doc.

@angelozerr angelozerr force-pushed the embed-doc branch 2 times, most recently from a55890e to e1699d5 Compare January 25, 2021 09:38
@fbricon
Copy link
Collaborator

fbricon commented Jan 25, 2021

we need to update the images matching the more recent changes (syntax highlighing makes things look much better)

@angelozerr angelozerr marked this pull request as ready for review January 25, 2021 10:23
@angelozerr
Copy link
Collaborator Author

we need to update the images matching the more recent changes (syntax highlighing makes things look much better)

I agree but the goal of this PR is to initialize embed documentation mechanism. We could do that in an another PR I think, because IMHO I think documentation should be more structured.

package.json Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
@angelozerr
Copy link
Collaborator Author

Here a demo with embed doc. Each settings from package.json are linked to the doc.

EmbedDoc

README.md Outdated Show resolved Hide resolved
docs/Producing.md Outdated Show resolved Hide resolved
docs/Consuming.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/Consuming.md Outdated Show resolved Hide resolved
docs/Producing.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@angelozerr angelozerr force-pushed the embed-doc branch 2 times, most recently from 8c4ce02 to 9afcf14 Compare January 27, 2021 14:36
@fbricon fbricon merged commit 1809450 into jlandersen:master Jan 27, 2021
@fbricon
Copy link
Collaborator

fbricon commented Jan 27, 2021

Thanks @angelozerr. We still need to improve the doc but at least we now have the foundation to do it.

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

Successfully merging this pull request may close these issues.

Provide embedded documentation
2 participants