Skip to content

Commit

Permalink
Add dev_notes link to user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmonettas committed Nov 1, 2023
1 parent 34a5294 commit 4a1f81c
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
6 changes: 6 additions & 0 deletions docs/user_guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1544,6 +1544,12 @@ works with jdk >= 17, and I think we still have a bunch of people on jdk 11.

== Internals, diagrams and documentation

For people interested in enhancing, troubleshooting, fixing or just learning about FlowStorm internals take a look at here :

https://github.com/flow-storm/flow-storm-debugger/blob/master/docs/dev_notes.md

Some useful diagrams :

- https://raw.githubusercontent.com/flow-storm/flow-storm-debugger/master/docs/high_level_diagram.svg
- https://raw.githubusercontent.com/flow-storm/flow-storm-debugger/master/docs/timeline.svg
- https://raw.githubusercontent.com/flow-storm/flow-storm-debugger/master/docs/run_configs.svg
Expand Down
11 changes: 10 additions & 1 deletion docs/user_guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -3225,6 +3225,15 @@ <h4 id="_ui_doesnt_work_on_macos"><a class="anchor" href="#_ui_doesnt_work_on_ma
</div>
<div class="sect2">
<h3 id="_internals_diagrams_and_documentation"><a class="anchor" href="#_internals_diagrams_and_documentation"></a><a class="link" href="#_internals_diagrams_and_documentation">25. Internals, diagrams and documentation</a></h3>
<div class="paragraph">
<p>For people interested in enhancing, troubleshooting, fixing or just learning about FlowStorm internals take a look at here :</p>
</div>
<div class="paragraph">
<p><a href="https://github.com/flow-storm/flow-storm-debugger/blob/master/docs/dev_notes.md" class="bare">https://github.com/flow-storm/flow-storm-debugger/blob/master/docs/dev_notes.md</a></p>
</div>
<div class="paragraph">
<p>Some useful diagrams :</p>
</div>
<div class="ulist">
<ul>
<li>
Expand All @@ -3242,7 +3251,7 @@ <h3 id="_internals_diagrams_and_documentation"><a class="anchor" href="#_interna
</div>
<div id="footer">
<div id="footer-text">
Last updated 2023-10-31 10:40:43 -0300
Last updated 2023-11-01 13:40:58 -0300
</div>
</div>
</body>
Expand Down

0 comments on commit 4a1f81c

Please sign in to comment.