-
Notifications
You must be signed in to change notification settings - Fork 0
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
Documentation and RAM limit #2
base: main
Are you sure you want to change the base?
Conversation
…configurable, etc
Attempts to limit use of RAM so that heap doesn't grow greater than 1GB. Minor bugfixes
Optimize namespace imports
Optimize namespace imports
Mainly focused on the documentation which looks clear to me. Unclear to me why "quisling" was added to the |
|
||
## REST | ||
|
||
Most REST calls are exist for debug and development reasons. |
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.
drop the "are" here
As a user of this service, all you need is ```POST /api/wiki``` | ||
|
||
### POST /api/wiki | ||
* consumerUrl: Wiki to be monitored for pre rendered. |
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.
Maybe add a clarification here that this should be set to the script path of the consumer wiki (i.e. the /w
part is expected)
Most REST calls are exist for debug and development reasons. | ||
As a user of this service, all you need is ```POST /api/wiki``` | ||
|
||
### POST /api/wiki |
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.
Would be good with a one-liner describing what the call does (similar to what you added to the calls below)
* mainPagePriority: (default: 10) Base priority of segments on Wiki main page. | ||
* maximumSynthesizedVoiceAgeInDays: (default: 30) Number of days before attempting to re-synthesizing segments on this Wiki. | ||
|
||
If initialLastRecentChangesLimitInHours is set to 0, then only new recent changes will be processed. |
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.
Maybe integrate this line into the parameter description above.
### POST /api/wiki | ||
* consumerUrl: Wiki to be monitored for pre rendered. | ||
* initialLastRecentChangesLimitInMinutes: (default: 60) Number of hours of initial recent changes backlog to be processed. | ||
* mainPagePriority: (default: 10) Base priority of segments on Wiki main page. |
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.
Should this be "Base priority multiplier of ..." per description under "## What this service does"
I brought over the relevant unresolved comments from PR #1 |
Better documentation
Attempting to limit heap to stay around 500MB-1GB
Many minor bugfixes