Skip to content

Update docs for 2.x#1433

Merged
robgjansen merged 11 commits intoshadow:devfrom
robgjansen:doc-update
Jun 15, 2021
Merged

Update docs for 2.x#1433
robgjansen merged 11 commits intoshadow:devfrom
robgjansen:doc-update

Conversation

@robgjansen
Copy link
Copy Markdown
Member

Includes:

  • more details about what shadow is and why it's important on the top-level readme
  • re-ordered the ToC in docs/readme to better organize contents into sections
  • added line breaks to long lines across all docs
  • more consistent use of terms like vertices->nodes, topology->graph
  • separate tgen example from shadow log parsing
  • and more

Sorry, the commits are not quite as easy to follow as they could be :/

@robgjansen robgjansen added the Component: Documentation In-repository documentation, under docs/ label Jun 14, 2021
@robgjansen robgjansen self-assigned this Jun 14, 2021
@robgjansen robgjansen requested a review from stevenengler June 14, 2021 19:52
@codecov
Copy link
Copy Markdown

codecov bot commented Jun 14, 2021

Codecov Report

Merging #1433 (1912c74) into dev (14f0c87) will increase coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##              dev    #1433   +/-   ##
=======================================
  Coverage   54.08%   54.09%           
=======================================
  Files         138      138           
  Lines       20456    20456           
  Branches     5171     5171           
=======================================
+ Hits        11064    11066    +2     
+ Misses       6471     6470    -1     
+ Partials     2921     2920    -1     
Flag Coverage Δ
tests 54.09% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/support/logger/rust_bindings/src/lib.rs 36.38% <0.00%> (+0.04%) ⬆️
src/main/host/thread_ptrace.c 49.50% <0.00%> (+0.16%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 14f0c87...1912c74. Read the comment docs.

@robgjansen robgjansen linked an issue Jun 14, 2021 that may be closed by this pull request
@stevenengler
Copy link
Copy Markdown
Contributor

Looks great! The organization is much nicer.

@robgjansen robgjansen enabled auto-merge June 15, 2021 12:52
@robgjansen robgjansen merged commit a48272f into shadow:dev Jun 15, 2021
@robgjansen robgjansen deleted the doc-update branch June 15, 2021 20:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Component: Documentation In-repository documentation, under docs/

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Scan and correct user documentation

3 participants