To gain better visibility you can complement your tech documentation with embedded source code, code snippets and readme files.

Include files

Including source code and readme files directly in the documentation:

  • allows developers and users to see the code in context;

  • provides clarity on how the code should be used and how it interacts with other components;

  • helps readers understand the implementation details and ensures accurate comprehension.

You can keep the file open/expanded or closed.

Сode Snippets

Readme embedding

Copy the readme path like https://github.сom/cjbarber/ToolsOfTheTrade/blob/master/