servicetalk icon indicating copy to clipboard operation
servicetalk copied to clipboard

Enhance docs to embed code

Open Scottmitch opened this issue 5 years ago • 4 comments

Some docs include code snippets from examples. For example the HTTP README.adoc. We should investigate tooling to extract code from examples to avoid duplication and stale docs.

Scottmitch avatar Apr 03 '19 16:04 Scottmitch

Hi,

Please let me know, if I can work on any part of it.

shekhar-rajak avatar Feb 08 '20 05:02 shekhar-rajak

@shekhar-rajak definetly, if you want to work on this, let us know and we can assign this to you. Also, if you need help discussing options, feel free to reach out.

NiteshKant avatar Feb 10 '20 18:02 NiteshKant

I think, for this we need tool like javasphinx

shekhar-rajak avatar Apr 17 '20 14:04 shekhar-rajak

@shekhar-rajak we use antora for document generation. You can refer to antora documentation to get an idea about how to do this with antora.

NiteshKant avatar Apr 19 '20 00:04 NiteshKant