vechain-sdk-js icon indicating copy to clipboard operation
vechain-sdk-js copied to clipboard

Docs :: Extract Specific Lines from Examples

Open Valazan opened this issue 1 year ago • 4 comments

Description

We often need to showcase specific parts of our code in the documentation. I propose a feature that allows us to specify line ranges in our executable code files and automatically include these lines in our documentation examples.

Expected Behavior

  • Ability to specify a line range (e.g., lines 10-32) or specific comments (e.g. //snippet1) when embedding markdown files
  • The specified line range should be automatically extracted and included in the documentation as an example.
  • If the source code updates, the snippets have to reflects the changes

Valazan avatar Jan 09 '24 16:01 Valazan

Examples should have the entire life cycle though and not only snippets

pierobassa avatar Jan 10 '24 08:01 pierobassa

We should also ensure that the entire code block is provided at the end of the file as a link.

nwbrettski avatar Jan 11 '24 15:01 nwbrettski

Image

nwbrettski avatar Jan 11 '24 16:01 nwbrettski

Doing this task as part of #650

Valazan avatar Mar 08 '24 17:03 Valazan