mirror of
https://github.com/gomods/athens
synced 2026-02-03 11:00:32 +00:00
3edd242848
Also doing a few things in the process: - Deprecating the documentation that references the filter file - Changing the order of the configuration documentation to put the deprecated documents at the bottom of the config section - Adding a note to the disk storage documentation about pre-filling the disk cache Fixes https://github.com/gomods/athens/issues/1501
1.0 KiB
1.0 KiB
title, date, weight
| title | date | weight |
|---|---|---|
| The Design of Athens | 2018-09-20T15:37:49-07:00 | 3 |
This section of the documentation details the design of Athens. You can read the code and ask plenty of questions (which we're always happy to answer!), but we want to take some time here to give you a head start by describing how Athens is designed in words and diagrams, rather than code.
What You'll Find Here
We've split this section into two major sections:
- Proxy internals - basics of the Athens proxy architecture and major features
- Communication flow - how the Athens proxy interacts with the outside world to fetch and store code, respond to user requests, and so on
How to Read this Section
We've designed the documentation in this section as a reference, which contrasts some of the other sections. That means that you don't need to read everything here from front to back to get value from it. We anticipate that you'll get the most out of this section while you're contributing to the project.