add protocol developer documentation#8666
Conversation
33403aa to
0dbf39c
Compare
|
The new md files need to be added to the dev-docs sources so they should up in an IDE. |
This comment was marked as outdated.
This comment was marked as outdated.
a83437c to
41243ef
Compare
|
@laz-001 we have landed the dev doc starting parts so be sure you rebase upon our current master, Just make sure you rebase Don't Merge update that will cause landing issues later on. |
41243ef to
6541536
Compare
This comment was marked as outdated.
This comment was marked as outdated.
6541536 to
4bdbc53
Compare
|
I am going to say we don't need the tutorial and much of what is in the reference should perhaps be doxygen comments within protocolTypes or other files .. ill let @nbolton comment there as my main issues were related to dev document deployment. |
This comment was marked as outdated.
This comment was marked as outdated.
4bdbc53 to
104d55b
Compare
I would not since the about should be user facing but we do need to link something to the dev docs |
104d55b to
7ab80d1
Compare
This comment was marked as outdated.
This comment was marked as outdated.
|
You have removed my links from the main page to the other pages i.e building / contributing also you have made no links to the new pages how are the users expected to find the pages ? |
sithlord48
left a comment
There was a problem hiding this comment.
Please put the links to the pages on the main page . Also put back the links to the build / contribute pages as well please
This comment was marked as resolved.
This comment was marked as resolved.
7ab80d1 to
357599d
Compare
357599d to
1d1f0cf
Compare
|
The diagram is fine just put links to the other markdown files. |
This comment was marked as outdated.
This comment was marked as outdated.
|
You need to add a link to the protocol_reference.md in the main page |
This comment was marked as outdated.
This comment was marked as outdated.
👋 I am part of that main review, While we wait for the others to lets get my simple nits out of the way. |
This comment was marked as outdated.
This comment was marked as outdated.
9588a49 to
70c5bac
Compare
nbolton
left a comment
There was a problem hiding this comment.
Looks good apart from a couple of minor points. I probably missed some things as that's a lot of documentation to grok in one go, but I think we're almost good to land.
70c5bac to
80cd026
Compare
It's an iterative process. Personally, I see many things when the docs are public facing. fixed those. To speed things up: if you see more things, please feel free to directly commit. |
whot
left a comment
There was a problem hiding this comment.
Only managed to do a skim, completely flat out atm but this LGTM, thanks. I think it meets the requirements of "can someone implement the protocol based on the documentation here?". The proof will be in the pudding when someone actually tries it :)
|
@laz-001 I don't mean to jerk you around with |
80cd026 to
942e39d
Compare
nbolton
left a comment
There was a problem hiding this comment.
So close, just a couple of things I missed last review.
942e39d to
1c0ed35
Compare
This comment was marked as resolved.
This comment was marked as resolved.
Yeah, I was a bit confused by latest push. I'll hang fire until you say so. |
should be ok now.
The thing is:
That's why: #8666 (comment) |
1c0ed35 to
6ecd3b0
Compare
6ecd3b0 to
c9b6dfe
Compare
|
@nbolton , all good from my side. This one needs to go in now, otherwise we end up refining for weeks. Each detail eats a day, further details are surely somewhere in there. I'm at the point that I need the closure - this is more about 'closing this step' than about the bounty. Doc edit goes on for me once docs are live - that's how I do it usually. As said, you can commit freely to this branch, I don't even care if I loose authorship (I purge/drop my github accounts anyways regularly). |
That is fine rather have it take abit longer to land then need a bunch of corrections after. Also makes issues easier to track since its all in one place.
You just lmk and i will take this over for you so you do not have to deal with the nit picks . |
|
No, no, I did NOT meant to give this PR even more live. What i meant to say was: instead of introducing one more day/cycle/iteration, just commit your stuff and merge (instead of waiting for me). E.g. if @nbolton finds something 'final' tomorrow, just commit and merge. |
nbolton
left a comment
There was a problem hiding this comment.
Finally.
Thanks for persevering!
|
🎉🎈 @laz-001 has been awarded $200 by Deskflow! 🎈🎊 |
/claim #8410
Can be merged after:
First Part
The first part of this work (not merged) :
(EDIT: Lost my flow a bit, took this path to be able to go on. I am currently revising this locally within my own setup, which allows me to iterate fast, without involving a full build.)