Skip to content

Improved documentation#38

Merged
coot merged 7 commits intomainfrom
coot/documentation
Mar 11, 2026
Merged

Improved documentation#38
coot merged 7 commits intomainfrom
coot/documentation

Conversation

@coot
Copy link
Copy Markdown
Contributor

@coot coot commented Mar 10, 2026

List of changes

  • Added default values to CLIOptions
  • Publish haddocks on github pages
  • Changed default confg file: dmq.config.json
  • Expanded README.md
  • Use ouroboros-network from CHaP
  • Fail gracefully when cardano node socket is missing

Checklist

  • related issue
  • My changes generate no new warnings
  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have added tests that prove my fix is effective or that my feature works

@github-project-automation github-project-automation bot moved this to In Progress in Ouroboros Network Mar 10, 2026
@coot coot added the documentation Improvements or additions to documentation label Mar 10, 2026
@coot coot linked an issue Mar 10, 2026 that may be closed by this pull request
@coot coot self-assigned this Mar 10, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates DMQ node documentation and build/dependency tooling, adds a GitHub Pages workflow for publishing Haddocks, and adjusts runtime/configuration defaults/behavior to better match current project expectations.

Changes:

  • Add CLI help defaults and update the default config filename to dmq.config.json.
  • Add a scheduled GitHub Pages workflow to build and publish Haddocks.
  • Update dependency pins (CHaP / cabal.project / flake.lock) and switch ouroboros-network dependency source/versioning.

Reviewed changes

Copilot reviewed 7 out of 8 changed files in this pull request and generated 17 comments.

Show a summary per file
File Description
flake.lock Updates CHaP pin (narHash/rev/lastModified).
dmq-node/src/DMQ/Configuration/CLIOptions.hs Adds displayed defaults to CLI options (currently affects precedence/overrides).
dmq-node/src/DMQ/Configuration.hs Changes default config filename and tweaks error string.
dmq-node/dmq-node.cabal Updates ouroboros-network constraint and adds directory dependency for executable.
dmq-node/app/Main.hs Adds socket-path existence check and adjusts program description/imports.
cabal.project Bumps index-state and updates source-repository-package pins/removals.
README.md Expands run/config docs and adds examples (with some command formatting/typos).
.github/workflows/github-page.yml New workflow to build Haddocks and deploy to GitHub Pages.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Copy link
Copy Markdown
Contributor

@karknu karknu left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Copy Markdown

Copilot AI commented Mar 10, 2026

@coot I've opened a new pull request, #39, to work on those changes. Once the pull request is ready, I'll request review from you.

@coot coot force-pushed the coot/documentation branch 3 times, most recently from 214a7ad to b112951 Compare March 10, 2026 16:25
@coot coot enabled auto-merge March 10, 2026 16:25
coot added 3 commits March 10, 2026 17:40
* Included basic run instructions.
* Added build docker image instructions.
@coot coot force-pushed the coot/documentation branch from b112951 to 3dbb4c2 Compare March 10, 2026 16:40
@coot coot disabled auto-merge March 10, 2026 17:15
@coot coot force-pushed the coot/documentation branch from 3dbb4c2 to 94407a6 Compare March 10, 2026 18:23
@coot coot enabled auto-merge March 10, 2026 18:24
@coot coot force-pushed the coot/documentation branch 2 times, most recently from 2470512 to 4e307f5 Compare March 11, 2026 14:23
@coot coot disabled auto-merge March 11, 2026 15:37
coot added 3 commits March 11, 2026 17:04
* ouroboros-network
* cardano-ledger
We cannot use `value <> showDefault`, since then the CLI will always
overwrite configuration option, so we show default with a custom helper
function.
GHC-9.12.2 suffers from a compiler bug which prevents building haddocks
https://gitlab.haskell.org/ghc/ghc/-/issues/25739
@coot coot force-pushed the coot/documentation branch from 4e307f5 to e227ad2 Compare March 11, 2026 16:05
@coot coot enabled auto-merge March 11, 2026 17:05
@coot coot added this pull request to the merge queue Mar 11, 2026
Merged via the queue into main with commit 6a55c52 Mar 11, 2026
8 of 9 checks passed
@coot coot deleted the coot/documentation branch March 11, 2026 17:47
@github-project-automation github-project-automation bot moved this from In Progress to Done in Ouroboros Network Mar 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

Update README file

4 participants