-
Notifications
You must be signed in to change notification settings - Fork 158
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: core-geth features, generated API method docs #306
Conversation
18ad0b8
to
084a13b
Compare
6031fbc
to
6c81d9c
Compare
Nice to have:
|
I'm gonna squash this and mark ready for review. |
- Creates generated markdown docs for API methods ./docs/JSON-RPC-API/modules - 'make docs-generate' (re)creates these files - ./docs/core/index.md is added including some hopefully useful information about what makes core-geth core-geth Date: 2021-01-15 06:43:58-06:00 Signed-off-by: meows <b5c6@protonmail.com>
b359bd5
to
75b4b1d
Compare
Aside from the generated API method docs (
|
- also fixup the accidentally-removed workaround for the cited open-rpc/meta-schema issue; see changes in node/node.go Date: 2021-01-21 14:04:37-06:00 Signed-off-by: meows <b5c6@protonmail.com>
This allows more precise deep (anchor) linking. Fixes the extra css which remove the too-much-information ul's from the right secondary nav. Date: 2021-01-21 17:37:47-06:00 Signed-off-by: meows <b5c6@protonmail.com>
Signed-off-by: meows <b5c6@protonmail.com>
Didn't work for me, but what do I know. Date: 2021-01-21 19:15:34-06:00 Signed-off-by: meows <b5c6@protonmail.com>
Just putting this out there... the generated docs in |
…ion examples Date: 2021-01-22 08:53:47-06:00 Signed-off-by: meows <b5c6@protonmail.com>
Date: 2021-01-22 08:56:05-06:00 Signed-off-by: meows <b5c6@protonmail.com>
This reverts commit 048f515. Turns out didn't work for him either.
Would be nice if they can be deterministic, though I can leave with that as this PR brings a lot of value in the docs. |
cc5afb0 begins the ordering solve. In fact, so far, it seems to be 100% effective. I don't think its a complete solution because the template also includes information (as
With these last two commits, I'm happy merging this and following up later if the |
…example Date: 2021-01-23 04:51:41-06:00 Signed-off-by: meows <b5c6@protonmail.com>
ef93cbd
to
de73918
Compare
Date: 2021-01-23 05:00:37-06:00 Signed-off-by: meows <b5c6@protonmail.com>
@ziogaschr PTAL #306 (comment). I'm OK with merging if you are. |
Looks fine for me at the moment. Nice work man. We can do a new PR when and if needed. |
Working on adding some documentation about what makes core-geth core-geth.
Resolves #308