Split out swarm-doc and swarm-tui sublibraries
#1834
Merged
Conversation
This file contains 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
- `Swarm.Doc.Pedagogy` depended on `Swarm.TUI.Controller`, but that was easy to resolve: it only needed `getTutorials`, which was easy to move to `Swarm.Game.ScenarioInfo` (which is a better place for it anyway). - A thornier problem is that the swarm-docs executable has an option for generating all the web API endpoints, so it depends on `Swarm.Web`. But `Swarm.Web` depends on `Swarm.Doc.Command` so that the list of commands can be accessed via the web interface. For now I commented out the `swarm-docs` command to print the web API, so `swarm-web` only depends on `swarm-doc` and not the other way around.
I'm fine with commenting that out for now. We can consider the web API docs a separate category of documentation from the other swarm docs, so it makes sense to exclude it from the swarm-docs library. |
kostmo
approved these changes
May 11, 2024
mergify bot
pushed a commit
that referenced
this pull request
May 13, 2024
As a follow-up to #1834: - Update the sublibrary graph generation script so it works with the no-longer-linear graph - Regenerate the actual image - Update the `.cabal` description to match
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Split the final remaining default library into
swarm-docandswarm-tui. Closes #1043 .