@sfdocs-internal/ssg

SSG

About

This is an engine which generates and publishes the statically generated sfdocs contents to a data store. The word for the day is Scale, Scale and Scale higher. SFDocs currently uses LWR as its underlying framework to render the markdowns, reference specs and other custom data types in SSR way. To scale the generation and publishing of docs, we would like to use the LWR's SSG feature and generate and publish the docs asynchronously which doesn't involve the DSC (developer.salesforce.com) server deployment.

The docs ssg engine which is presented here will take care of generation and publishing of the SFDocs documents based on a schedule to present with initially and will be later extended to support real time on the spot generation and publishing engine, which will target only the modified content repository contents.

High Level Design

Detailed design about the high level components of this engine is presented here: https://salesforce.quip.com/c9TCAjg83bsq Please note that this is a high level design and individual components may subject to change in the implementation.