Initial check in of documentation from core docs to ACE Repo #38
Conversation
| The Merkle trees can be kept up-to-date automatically by running the `mtree listen` command, which uses Change Data Capture (CDC) with the `pgoutput` output plugin to track row changes. Performing the `mtree table-diff` will update the Merkle tree even if `mtree listen` is not used. | ||
| ### Building the Documentation |
There was a problem hiding this comment.
I think we can move this to some place inside the docs/ directory. The main README file of the repo could have essential docs to get started.
There was a problem hiding this comment.
Are we using all these images in the docs for ACE?
There was a problem hiding this comment.
@susan-pgedge, could you do a pass on the images directory and remove all images unrelated to ACE?
| @@ -0,0 +1,337 @@ | |||
|
|
|||
| ## ACE API Endpoints | |||
There was a problem hiding this comment.
REST APIs are an upcoming feature in Golang ACE. They are only available in the Python version of ACE. We should remove this file for now.
|
|
||
| ACE includes API endpoints for some of its most frequently used functions. | ||
|
|
||
| ## API Reference |
There was a problem hiding this comment.
Although, at a high level, the functions are the same, there are subtle differences between the Python and Golang versions of ACE. I think we shouldn't be adding the Python ACE-related docs to this repo.
| @@ -0,0 +1,194 @@ | |||
| # Scheduling ACE Diff Operations (Beta) | |||
There was a problem hiding this comment.
Scheduling isn't available with Golang ACE just yet. Please delete this file.
2 participants
The docs moved have been put into MkDocs format, but the repo still needs a .yaml file...