Skip to content
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

Module guide #1689

Open
byorgey opened this issue Dec 14, 2023 · 1 comment
Open

Module guide #1689

byorgey opened this issue Dec 14, 2023 · 1 comment
Labels
C-Moderate Effort Should take a moderate amount of time to address. Z-Developer Experience This issue seeks to make life easier for developers writing Scenarios or other Swarm code. Z-Documentation This issue is about README or Wikis or Haddock or...

Comments

@byorgey
Copy link
Member

byorgey commented Dec 14, 2023 •
edited
Loading

There are so many modules now that I often have real trouble finding the right place to make the changes I want to make. It would be nice to have some kind of developer guide on the wiki which explains the organization of the codebase and gives some general hints about what can be found in various modules (though we don't necessarily need to list every single module). The challenge, of course, would be keeping it up to date.
@byorgey byorgey added C-Low Hanging Fruit Ideal issue for new contributors. Z-Documentation This issue is about README or Wikis or Haddock or... Z-Developer Experience This issue seeks to make life easier for developers writing Scenarios or other Swarm code. labels Dec 14, 2023
@kostmo kostmo mentioned this issue Dec 15, 2023
Merged
@kostmo
Copy link
Member

kostmo commented Dec 15, 2023

In addition to documentation, #1043 will surely help with this.

mergify bot pushed a commit that referenced this issue Dec 16, 2023
@kostmo
short module descriptions (#1690)
7fa97b6 
Towards #1689

The [`Description:` field](https://haskell-haddock.readthedocs.io/en/latest/markup.html#the-module-description) in a module's toplevel haddock will be displayed on the Contents page.

![Screenshot from 2023-12-14 20-55-26](https://github.com/swarm-game/swarm/assets/261693/841f2834-8273-4394-b764-8f5f4479b9c4)
@kostmo kostmo mentioned this issue Jan 7, 2024
Merged
mergify bot pushed a commit that referenced this issue Jan 8, 2024
@kostmo
autogenerated sublibrary diagram (#1720)
a94ab9d 
Towards #1689

![sublibrary-graph](https://github.com/swarm-game/swarm/assets/261693/b300fb0d-be59-4fc9-a042-04ceaf4909b2)
@byorgey byorgey mentioned this issue May 13, 2024
Merged
@byorgey byorgey mentioned this issue Jun 14, 2024
Open
@byorgey byorgey added C-Moderate Effort Should take a moderate amount of time to address. and removed C-Low Hanging Fruit Ideal issue for new contributors. labels Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
C-Moderate Effort Should take a moderate amount of time to address. Z-Developer Experience This issue seeks to make life easier for developers writing Scenarios or other Swarm code. Z-Documentation This issue is about README or Wikis or Haddock or...
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@kostmo @byorgey