Skip to content

Updates documentation for new functional proter #71

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.

Sign up for GitHub

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

Jump to bottom
Draft
PetrosPapapa wants to merge 31 commits into
base: fp
Choose a base branch
from
Draft

Updates documentation for new functional proter #71

PetrosPapapa wants to merge 31 commits into from

Conversation

@PetrosPapapa
Copy link
Member

@PetrosPapapa PetrosPapapa commented Jul 30, 2022 •
edited
Loading

Updates the following:

  • Main scaladocs
  • Server scaladocs
  • Server API doc via Swagger
  • Webpage with setup instructions and link to server API

@PetrosPapapa PetrosPapapa added the code improvement requires improvements in the code such as cleaning up or commenting/documentation label Jul 30, 2022
@PetrosPapapa PetrosPapapa added this to the Scala 3 & FP Migration milestone Jul 30, 2022
@PetrosPapapa PetrosPapapa self-assigned this Jul 30, 2022
@PetrosPapapa
Flattens JSON encoding of TaskInstance maps in JsonHandler
3866c9b
@PetrosPapapa
Completes OpenAPI spec
7bcbd14
@PetrosPapapa
Improves Simulator.stream to ensure we get all the events through
7f3021c 
Reverts to `Topic.subscribeAwait`, making use of `Stream.resource`.
@PetrosPapapa
Adds small additions and improvements to the OpenAPI spec
1a7afe2
@PetrosPapapa
Adds sbt-swagger-ui - to be tested
2f3a1f1 
Does not work on Windows :(
@PetrosPapapa
Reverts to a static swagger ui deployment
6abdac2
@PetrosPapapa
Updates docs config and front page with openapi links
837ba9a
@PetrosPapapa
Updates docs.org with server documentation
f0aced2
@PetrosPapapa
Makes progress in elements documentation up to Tasks
319e1b9
@PetrosPapapa
Moves DiscreteEvent.scala to its own discrete package
c400925 
Helps keep things a bit more tidy, especially since the discrete
events are mostly an internal thing.
@PetrosPapapa
Adds documentation of CaseRef and Case
74cf33f
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@PetrosPapapa PetrosPapapa

Labels

code improvement requires improvements in the code such as cleaning up or commenting/documentation

Projects

None yet

Milestone

Scala 3 & FP Migration

Development

Successfully merging this pull request may close these issues.

2 participants

@PetrosPapapa