Skip to content

Conversation

@williamdemeo
Copy link
Member

@williamdemeo williamdemeo commented Oct 21, 2025

Description

Checklist

  • Commit sequence broadly makes sense and commits have useful messages
  • Any semantic changes to the specifications are documented in CHANGELOG.md
  • Code is formatted according to CONTRIBUTING.md
  • Self-reviewed the diff

@williamdemeo williamdemeo linked an issue Oct 21, 2025 that may be closed by this pull request
11 tasks
@williamdemeo williamdemeo marked this pull request as ready for review October 29, 2025 05:07
Copy link
Collaborator

@carlostome carlostome left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Just a couple of comments:

  • In the home page "Home" on the left column looks weird.
  • The symbol > to expand a directory looks a bit odd all the way to the right.
  • I'd hoist Core to its own tab.

@williamdemeo
Copy link
Member Author

williamdemeo commented Oct 30, 2025

Looks good! Just a couple of comments:

  • In the home page "Home" on the left column looks weird.
  • The symbol > to expand a directory looks a bit odd all the way to the right.

Not really sure what we can do about these two items... but I'll try to figure something out.

  • I'd hoist Core to its own tab.

Okay, that's how it was before. I'll revert. 👍🏼

Also, I don't really like that Interface is a mix of two very different kinds of modules:

  1. STS and ComputationalRelation
  2. Type class definitions and instances

I suggest we leave STS and ComputationalRelation as "top-level" submodules of Interface and move the type class modules into a subdirectory called TypeClasses. @carlostome what do you think? I'll effect and push that change now and wait for the CI to pass before merging. I'll also try to fix the location of the > symbols that expand directories.

@williamdemeo
Copy link
Member Author

As for the "Home" on the left side of the index page, whatever we name the tab at the top will show up on the far left. I'm not sure if we can do anything about that. Let's leave it for now.

As for the >, I'm not sure if we can avoid the right-alignment, but I did manage to make it a little less far to the right by adjusting .md-sidebar--primary .md-nav__list at the bottom of custom.css.

+ improve Dijkstra.Transaction
+ improve toc
+ add intro to "top-level" Spec modules
+ move Core up
+ improve layout of toc via css
+ move type class defs
+ add intro for `Ledger.Core.Specification`
@williamdemeo williamdemeo force-pushed the 826-niceties--improve-toc branch from 2df4a44 to 56bb7f3 Compare October 30, 2025 04:48
@williamdemeo williamdemeo force-pushed the 826-niceties--improve-toc branch from 56bb7f3 to e0068fd Compare October 30, 2025 05:39
@williamdemeo williamdemeo merged commit a008c4f into master Oct 30, 2025
12 checks passed
@williamdemeo williamdemeo deleted the 826-niceties--improve-toc branch October 30, 2025 06:25
@williamdemeo williamdemeo self-assigned this Nov 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Niceties to have in the MkDocs site

2 participants