Home / Input Output / ouroboros-consensus
Jan 14, 2-3 AM (0)
Jan 14, 3-4 AM (0)
Jan 14, 4-5 AM (0)
Jan 14, 5-6 AM (0)
Jan 14, 6-7 AM (0)
Jan 14, 7-8 AM (0)
Jan 14, 8-9 AM (0)
Jan 14, 9-10 AM (0)
Jan 14, 10-11 AM (0)
Jan 14, 11-12 PM (0)
Jan 14, 12-1 PM (0)
Jan 14, 1-2 PM (0)
Jan 14, 2-3 PM (1)
Jan 14, 3-4 PM (1)
Jan 14, 4-5 PM (0)
Jan 14, 5-6 PM (0)
Jan 14, 6-7 PM (0)
Jan 14, 7-8 PM (0)
Jan 14, 8-9 PM (0)
Jan 14, 9-10 PM (0)
Jan 14, 10-11 PM (1)
Jan 14, 11-12 AM (0)
Jan 15, 12-1 AM (0)
Jan 15, 1-2 AM (0)
Jan 15, 2-3 AM (0)
Jan 15, 3-4 AM (0)
Jan 15, 4-5 AM (0)
Jan 15, 5-6 AM (0)
Jan 15, 6-7 AM (0)
Jan 15, 7-8 AM (0)
Jan 15, 8-9 AM (0)
Jan 15, 9-10 AM (0)
Jan 15, 10-11 AM (1)
Jan 15, 11-12 PM (0)
Jan 15, 12-1 PM (1)
Jan 15, 1-2 PM (1)
Jan 15, 2-3 PM (0)
Jan 15, 3-4 PM (0)
Jan 15, 4-5 PM (0)
Jan 15, 5-6 PM (0)
Jan 15, 6-7 PM (0)
Jan 15, 7-8 PM (0)
Jan 15, 8-9 PM (0)
Jan 15, 9-10 PM (0)
Jan 15, 10-11 PM (0)
Jan 15, 11-12 AM (0)
Jan 16, 12-1 AM (0)
Jan 16, 1-2 AM (0)
Jan 16, 2-3 AM (0)
Jan 16, 3-4 AM (0)
Jan 16, 4-5 AM (0)
Jan 16, 5-6 AM (0)
Jan 16, 6-7 AM (0)
Jan 16, 7-8 AM (0)
Jan 16, 8-9 AM (0)
Jan 16, 9-10 AM (0)
Jan 16, 10-11 AM (0)
Jan 16, 11-12 PM (0)
Jan 16, 12-1 PM (0)
Jan 16, 1-2 PM (0)
Jan 16, 2-3 PM (0)
Jan 16, 3-4 PM (0)
Jan 16, 4-5 PM (3)
Jan 16, 5-6 PM (0)
Jan 16, 6-7 PM (0)
Jan 16, 7-8 PM (0)
Jan 16, 8-9 PM (0)
Jan 16, 9-10 PM (0)
Jan 16, 10-11 PM (0)
Jan 16, 11-12 AM (0)
Jan 17, 12-1 AM (0)
Jan 17, 1-2 AM (0)
Jan 17, 2-3 AM (0)
Jan 17, 3-4 AM (0)
Jan 17, 4-5 AM (0)
Jan 17, 5-6 AM (0)
Jan 17, 6-7 AM (0)
Jan 17, 7-8 AM (0)
Jan 17, 8-9 AM (0)
Jan 17, 9-10 AM (1)
Jan 17, 10-11 AM (0)
Jan 17, 11-12 PM (2)
Jan 17, 12-1 PM (0)
Jan 17, 1-2 PM (0)
Jan 17, 2-3 PM (0)
Jan 17, 3-4 PM (0)
Jan 17, 4-5 PM (0)
Jan 17, 5-6 PM (0)
Jan 17, 6-7 PM (0)
Jan 17, 7-8 PM (0)
Jan 17, 8-9 PM (0)
Jan 17, 9-10 PM (0)
Jan 17, 10-11 PM (2)
Jan 17, 11-12 AM (0)
Jan 18, 12-1 AM (0)
Jan 18, 1-2 AM (0)
Jan 18, 2-3 AM (0)
Jan 18, 3-4 AM (0)
Jan 18, 4-5 AM (0)
Jan 18, 5-6 AM (0)
Jan 18, 6-7 AM (0)
Jan 18, 7-8 AM (0)
Jan 18, 8-9 AM (0)
Jan 18, 9-10 AM (0)
Jan 18, 10-11 AM (0)
Jan 18, 11-12 PM (0)
Jan 18, 12-1 PM (0)
Jan 18, 1-2 PM (0)
Jan 18, 2-3 PM (0)
Jan 18, 3-4 PM (0)
Jan 18, 4-5 PM (0)
Jan 18, 5-6 PM (0)
Jan 18, 6-7 PM (0)
Jan 18, 7-8 PM (0)
Jan 18, 8-9 PM (0)
Jan 18, 9-10 PM (0)
Jan 18, 10-11 PM (0)
Jan 18, 11-12 AM (0)
Jan 19, 12-1 AM (0)
Jan 19, 1-2 AM (0)
Jan 19, 2-3 AM (0)
Jan 19, 3-4 AM (0)
Jan 19, 4-5 AM (0)
Jan 19, 5-6 AM (0)
Jan 19, 6-7 AM (0)
Jan 19, 7-8 AM (0)
Jan 19, 8-9 AM (0)
Jan 19, 9-10 AM (0)
Jan 19, 10-11 AM (0)
Jan 19, 11-12 PM (0)
Jan 19, 12-1 PM (0)
Jan 19, 1-2 PM (0)
Jan 19, 2-3 PM (0)
Jan 19, 3-4 PM (0)
Jan 19, 4-5 PM (0)
Jan 19, 5-6 PM (0)
Jan 19, 6-7 PM (0)
Jan 19, 7-8 PM (0)
Jan 19, 8-9 PM (0)
Jan 19, 9-10 PM (0)
Jan 19, 10-11 PM (0)
Jan 19, 11-12 AM (0)
Jan 20, 12-1 AM (0)
Jan 20, 1-2 AM (0)
Jan 20, 2-3 AM (0)
Jan 20, 3-4 AM (0)
Jan 20, 4-5 AM (0)
Jan 20, 5-6 AM (0)
Jan 20, 6-7 AM (0)
Jan 20, 7-8 AM (0)
Jan 20, 8-9 AM (0)
Jan 20, 9-10 AM (2)
Jan 20, 10-11 AM (2)
Jan 20, 11-12 PM (0)
Jan 20, 12-1 PM (0)
Jan 20, 1-2 PM (0)
Jan 20, 2-3 PM (0)
Jan 20, 3-4 PM (0)
Jan 20, 4-5 PM (0)
Jan 20, 5-6 PM (0)
Jan 20, 6-7 PM (0)
Jan 20, 7-8 PM (0)
Jan 20, 8-9 PM (0)
Jan 20, 9-10 PM (0)
Jan 20, 10-11 PM (0)
Jan 20, 11-12 AM (0)
Jan 21, 12-1 AM (0)
Jan 21, 1-2 AM (0)
Jan 21, 2-3 AM (0)
18 commits this week Jan 14, 2025 - Jan 21, 2025
Ignore/fix broken links
Problem: several links in Markdown files are broken.

Solution:

1. Links in References.md, index.md and TechnicalReports.md
   are invalid in the sense of Markdown and this repo, but
   they work on the website, so they are explicitly ignored.

2. Glossary.md contains many links to anchors in the same file.
   These anchors work differently in Markdown and Docusarus as can
   be seen here:
   https://ouroboros-consensus.cardano.intersectmbo.org/docs/for-developers/Glossary/
   Ideally, they should be fixed to work on the resulting website,
   in which case all of them would be broken in the sense of Markdown.
   Fixing them for Docusaurus is out of scope of this commit,
   but we force xrefcheck to ignore all links in that file in
   preparation for that fix.

3. There is also an anchor link in VersioningSchemeDecision.md,
   but this file is not used in the resulting website, so we fix
   it according to Markdown rules.

4. Redirects have been replaced with direct links to make opening links
   more efficient for readers.

5. Fixed outdated links and anchors in CONTRIBUTING.md and
   ouroboros-consensus-cardano/README.md
[#4] Use xrefcheck to check links on CI
Problem: Markdown files contain a plenty of links which
tend to get outdated occasionally. It's hard to notice when
a certain link (local or global) becomes broken.

Solution: in the past, the `xrefcheck` tool was used
to find broken links:
* https://github.com/IntersectMBO/ouroboros-consensus/pull/3
* https://github.com/IntersectMBO/ouroboros-consensus/pull/454

See https://github.com/serokell/xrefcheck
This PR automates `xrefcheck` running by adding it as a new
GitHub Action job.
It uses [xrefcheck-action](https://github.com/serokell/xrefcheck-action)
under the hood.

Resolves #4
[#4] Use xrefcheck to check links on CI
Problem: Markdown files contain a plenty of links which
tend to get outdated occasionally. It's hard to notice
when a certain link (local or global) becomes broken.

Solution: in the past, the `xrefcheck` tool was used
to find broken links:
* https://github.com/IntersectMBO/ouroboros-consensus/pull/3
* https://github.com/IntersectMBO/ouroboros-consensus/pull/454

See https://github.com/serokell/xrefcheck
This PR automates `xrefcheck` running by adding it as a new
GitHub Action job.
It uses [xrefcheck-action](https://github.com/serokell/xrefcheck-action)
under the hood.

Resolves #4
Ignore/fix broken links
Problem: several links in Markdown files are broken.

Solution:

1. Links in References.md, index.md and TechnicalReports.md
   are invalid in the sense of Markdown and this repo, but
   they work on the website, so they are explicitly ignored.

2. Glossary.md contains many links to anchors in the same file.
   These anchors work differently in Markdown and Docusarus as can
   be seen here:
   https://ouroboros-consensus.cardano.intersectmbo.org/docs/for-developers/Glossary/
   Ideally, they should be fixed to work on the resulting website,
   in which case all of them would be broken in the sense of Markdown.
   Fixing them for Docusaurus is out of scope of this commit,
   but we force xrefcheck to ignore all links in that file in
   preparation for that fix.

3. There is also an anchor link in VersioningSchemeDecision.md,
   but this file is not used in the resulting website, so we fix
   it according to Markdown rules.

4. Redirects have been replaced with direct links to make opening links
   more efficient for readers.

5. Fixed outdated links and anchors in CONTRIBUTING.md and
   ouroboros-consensus-cardano/README.md