Add Scheduling docs for 3.1 - #81
Merged
Merged
Conversation
Add the Schedule & Availability, Schedule Exception and Token modules: refreshed schedule and token concepts, a new schedule exception concept, and eleven flows. Adds a Scheduling category to the 3.1 flows sidebar.
Deploying coredocs with
|
| Latest commit: |
48571fe
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://7a954ba4.coredocs.pages.dev |
| Branch Preview URL: | https://docs-scheduling-flows.coredocs.pages.dev |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Generated by Docs Reviewer for #81 · opus50 · 207.2 AIC · ⌖ 15.8 AIC · ⊞ 11K
| ] | ||
| }, | ||
| { | ||
| "type": "category", |
Contributor
There was a problem hiding this comment.
Mirroring (checklist 11). This whole change lands only in 3.1. The shared conventions keep versioned_docs/version-3.0 and version-3.1 byte-identical, so the 3.0 copies are missing: versioned_docs/version-3.0/concepts/scheduling/{schedule,token,exception}.mdx, the entire versioned_docs/version-3.0/flows/scheduling/ tree, and this same Scheduling category in versioned_sidebars/version-3.0-sidebars.json.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What
Adds documentation for three Scheduling modules. These were written from scratch against the backend and frontend sources — they did not exist in
care_docsbefore.Schedule & Availability
concepts/scheduling/schedule.mdxSchedule Exception (new)
concepts/scheduling/exception.mdxToken
concepts/scheduling/token.mdxAdds a
Schedulingcategory to the 3.1 flows sidebar with the three modules nested under it.Where the content comes from
Grounded in:
care/emr/models/scheduling/—Schedule,Availability,AvailabilityException,SchedulableResource,Token,TokenQueue,TokenSubQueue,TokenCategorycare/emr/resources/scheduling/— field-level specs, enums and validation rulescare/security/permissions/schedule.pyandtoken.py— exact permission namescare_fe/src/pages/Scheduling/,src/pages/Facility/queues/,src/components/Tokens/andpublic/locale/en.json— UI labelsPlease review the flow steps closely
Field names, enums, validation rules and permissions are taken directly from the source and should be accurate. The step-by-step navigation in the flows is the weaker part: the entry points ("Open the facility. Go to the scheduling section…") were inferred from the component structure rather than verified by clicking through the product. Anywhere the exact menu path matters, please correct it.
Specifically worth checking:
Verification
Docusaurus build passes for both
enandmllocales.