-
Notifications
You must be signed in to change notification settings - Fork 4k
Introduce slim documents #3140
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
base: main
Are you sure you want to change the base?
Introduce slim documents #3140
Conversation
🦋 Changeset detectedLatest commit: 35dfe45 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
5dd86f9
to
e06d5ed
Compare
Summary of the deployments: Version 1
Version 2
Test content |
e06d5ed
to
388b297
Compare
061967f
to
526fcdc
Compare
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
We introduce slim documents, it's a lighter version of the document computed in GitBook Open to lightweight to document stored in cache and transferred to client. The idea is to store in this document only what is needed to display a document in GitBook Open.
526fcdc
to
35dfe45
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My first thought is: why doesn't this live in the API?
@emmerich it's tight to GBO and what we display in it. I think it's easier to maintain here. @SamyPesse didn't want it in the API |
@emmerich It should not be done in the API, because the choice of what data is important or not to be stored in the cache is relative to what GBO needs to do. Our API should always respond with "all" the properties needed for different use-cases (some properties are useless on revision pages for GBO, but needed for our users using the API). GBO can then choose to pick only some properties to select and cache; depending on what is being used. In the API, we should just get rid of some deprecated properties on |
We introduce slim documents, it's a lighter version of the document
computed in GitBook Open to lightweight to document stored in cache and
transferred to client. The idea is to store in this document only what
is needed to display a document in GitBook Open.
Fix RND-6822