Docs: Add Architecture page #169
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@robertjdominguez Thanks for your PR! I've assigned @robertjdominguez to review it. |
Deploying promptql-docs with
|
| Latest commit: |
c2ce78a
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://a0298962.promptql-docs.pages.dev |
| Branch Preview URL: | https://robdominguez-doc-2910-add-ar.promptql-docs.pages.dev |
Adds a page for Architecture that's purposefully very broad. If you take a peek at the categories in the sidebar, we enter with the quickstart for end users and then build by talking about capabilities, steering, and use cases. This is the first page in the Core Concepts section and is meant to be as high-level of an overview as possible. We could—and should—introduce a section within this page that highlights differences bewteen the data and control planes. But, for now, this simply serves to illustrate the various services that are running and how they work together to produce the end-user experience. An easy way to think of this: what's (relevant) in the root `compose.yaml` and what does each service do?
robertjdominguez
force-pushed
the
robdominguez/doc-2910-add-architecture-overview
branch
from
aaadb98 to
c2ce78a
Compare
robertjdominguez
deleted the
robdominguez/doc-2910-add-architecture-overview
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description 📝
Adds a page for Architecture that's purposefully very broad.
If you take a peek at the categories in the sidebar, we enter with the quickstart for end users and then build by talking about capabilities, steering, and use cases.
This is the first page in the Core Concepts section and is meant to be as high-level of an overview as possible. We could—and should—introduce a section within this page that highlights differences between the data and control planes. But, for now, this simply serves to illustrate the various services that are running and how they work together to produce the end-user experience.
An easy way to think of this: what's (relevant) in the root
compose.yamland what does each service do?Quick Links 🚀
Architecture