OSRB documentation review by progala · Pull Request #68 · networktocode/jdiff

progala · 2022-07-21T09:48:53Z

First pass of the documentation review.

General comments:

We should think about breaking the readme into multiple documents. This should help us with structuring it better as well.
I've reworded some of the sections and added questions and suggestions on lines starting with | Przemek:
We should involve Dwight in the process to help with reviewing language and grammar.

Release v0.0.1-beta.1

lvrfrc87 · 2022-07-25T09:01:22Z

@progala Can we have your opinion on Christian comments so I can do the required changes?
Thanks a lot.

Rename lib from netcompare into jdiff

… into docs-review

…networktocode-llc/netcompare into docs-review

scetron

@progala @chadell @jeffkala I've made a good number of updates to the Readme. Some of these sections will become parts of the expanded doc, but I wanted to get your take on them for now. Please have a look at the changes and leave any comments.

… into docs-review

…tcompare into docs-review

progala · 2022-08-26T15:49:25Z

@lvrfrc87 @scetron Thanks for making the changes! We're good to merge.

jeffkala

Also looks like a few of the diagrams/PNG files still reference NETCOMPARE insetad of JDIFF.

lvrfrc87 and others added 3 commits March 30, 2022 12:01

Merge pull request #51 from networktocode-llc/release-v0.0.1-beta.1

ebca5d3

Release v0.0.1-beta.1

Merge pull request #52 from networktocode-llc/develop

1604af7

Release v0.0.1-beta.1

OSRB docs review, first pass

7fbdedd

progala requested review from chadell, grelleum, jeffkala, lvrfrc87, pke11y, pszulczewski and scetron as code owners July 21, 2022 09:48

chadell reviewed Jul 22, 2022

View reviewed changes

Comment thread README.md Outdated

chadell reviewed Jul 22, 2022

View reviewed changes

Comment thread README.md Outdated

lvrfrc87 mentioned this pull request Jul 26, 2022

Update doc as per OSRB request #70

Closed

lvrfrc87 and others added 11 commits July 26, 2022 09:45

Merge branch 'lvrfrc87' into docs-review

78273c9

Merge branch 'develop' into docs-review

a3a355d

Merge pull request #73 from networktocode-llc/develop

bc57e6a

Rename lib from netcompare into jdiff

Merge branch 'main' into docs-review

95f50b6

readme updates

ee9abee

migrate get_value method into function and rename

f9a6c6e

Merge branch 'docs-review' of github.com:networktocode-llc/netcompare…

2e2363f

… into docs-review

updates

c9600d9

Merge branches 'docs-review' and 'docs-review' of https://github.com/…

4966f04

…networktocode-llc/netcompare into docs-review

updates

2d67a40

edits

163424f

scetron reviewed Jul 29, 2022

View reviewed changes

lvrfrc87 added 2 commits August 1, 2022 10:41

update evaluate signature for check method

25383ef

Merge branch 'docs-review' of github.com:networktocode-llc/netcompare…

12c2b9c

… into docs-review

scetron previously approved these changes Aug 1, 2022

View reviewed changes

progala commented Aug 8, 2022

View reviewed changes

Comment thread README.md Outdated

Comment thread README.md Outdated

Comment thread README.md Outdated

Comment thread README.md Outdated

Comment thread README.md Outdated

Comment thread README.md Outdated

Comment thread README.md

scetron added 2 commits August 23, 2022 10:24

update mkdocs

e83833a

remove comment

7e6ea96

progala commented Aug 23, 2022

View reviewed changes

Comment thread README.md Outdated

Comment thread docs/architecture.md Outdated

scetron and others added 7 commits August 23, 2022 14:21

few more edits

8748393

replace output arg with data

b3a31db

fix tests

6cfb0a4

Update README.md

e1e72d9

doc updates from review

989945e

Merge branch 'docs-review' of https://github.com/networktocode-llc/ne…

da13fc6

…tcompare into docs-review

not-range to not-in-range

c623920

progala commented Aug 25, 2022

View reviewed changes

scetron and others added 6 commits August 25, 2022 10:29

update/check usage examples

bf546d7

add workflow summary to usage

451cb18

update arch examples

eb8eaf7

Update docs/usage.md

a341561

Update docs/usage.md

55672ed

Update docs/usage.md

a6bcff3

progala commented Aug 26, 2022

View reviewed changes

Comment thread docs/usage.md Outdated

Comment thread docs/usage.md Outdated

progala and others added 4 commits August 26, 2022 11:10

Update docs/usage.md

01a17e0

Update docs/usage.md

3dc349e

update architecture image

278bb38

fix links

2dff682

progala commented Aug 26, 2022

View reviewed changes

Comment thread docs/index.md Outdated

Update docs/index.md

d3a569a

jeffkala requested changes Aug 26, 2022

View reviewed changes

Comment thread docs/architecture.md Outdated

Comment thread docs/index.md

scetron added 2 commits August 26, 2022 14:26

edits

a4e9eb3

update netcompare -> jdiff

97817f3

scetron merged commit f70f683 into develop Aug 31, 2022

lvrfrc87 deleted the docs-review branch September 26, 2022 13:33

Uh oh!

Conversation

progala commented Jul 21, 2022

Uh oh!

Uh oh!

Uh oh!

lvrfrc87 commented Jul 25, 2022

Uh oh!

scetron left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

progala commented Aug 26, 2022

Uh oh!

jeffkala left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

scetron left a comment •

edited

Loading