Skip to content
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

Add guide on high level Trinity architecture #889

Merged

Conversation

cburgdorf
Copy link
Contributor

@cburgdorf cburgdorf commented Jun 11, 2018

What was wrong?

The documentation is lacking a high level architecture guide for Trinity (e.g. explain layer, processes and other core things)

How was it fixed?

Wrote such a guide.

Teaser

guide_tease_2

Known issues:

  • the graphics aren't that professional. I'm not a designer and these should act as stubs until someone who knows this stuff steps in
  • still missing plenty of things that would fit into the topic
  • links to some APIs don't work yet because we don't have them in our API docs yet
  • links to some Python APIs don't work yet because I assume we need to configure something for that)

Cute Animal Picture

put a cute animal picture link inside the parentheses

@cburgdorf cburgdorf force-pushed the christoph/docs/trinity-high-level-view branch 2 times, most recently from 5f313bf to 97e1c7f Compare June 11, 2018 15:46
@cburgdorf cburgdorf changed the title WIP: Add guide on high level Trinity architecture Add guide on high level Trinity architecture Jun 11, 2018
@carver
Copy link
Contributor

carver commented Jun 11, 2018

links to some Python APIs don't work yet because I assume we need to configure something for that

Which python API reference is not linking as expected? Intersphinx is set up correctly for linking out to python, afaict.

@cburgdorf cburgdorf force-pushed the christoph/docs/trinity-high-level-view branch from 97e1c7f to edaaf38 Compare June 12, 2018 07:55
@cburgdorf
Copy link
Contributor Author

@carver turns out I just had the linking syntax wrong. Links to BaseManager and BaseProxy are now working as intended.

@cburgdorf cburgdorf merged commit 0fe47ac into ethereum:master Jun 12, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants