Skip to content

Commit 4b9af4c

Browse files
committed
Landing page: current package names, registries and install lines
RansacScoringDoneRight is now RANSACScoringDoneRight (graph node, card, install lines, footer, icon title, portal navbar; its old /RansacScoringDoneRight/ portal redirects keep their path). Every package card gives its README purpose, its docs (the monorepo packages' own Documenter sites under VisualGeometryToolkit.jl/<Package>/stable/), its repository, its pkg> add line and its registry: General for the six monorepo packages and RANSACScoringDoneRight, CauRegistry with General pending for LocalOptimizationDoneRight, BlobBoards and PanoramaStitching. Get started uses pkg> lines with the CauRegistry registry add line, and no longer claims that VisualGeometryToolkitEstimation brings RANSACScoringDoneRight. The graph cites the dependency allow-list. The toolkit citation carries its Zenodo concept DOI (10.5281/zenodo.23548372); the BlobBoards paper links its data record (10.5281/zenodo.21998310) and its BibTeX gains the arXiv eprint. lychee: the relative-docs remap and the pre-tag stable/ exclusion are gone.
1 parent 1c3cfd1 commit 4b9af4c

8 files changed

Lines changed: 89 additions & 79 deletions

File tree

‎.github/workflows/links.yml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Dead-link check (lychee) over the hand-written landing page and the README,
2-
# with the exclusions and accepted codes in .lychee.toml; the landing page's
3-
# relative package-docs links are checked on the published site. Runs on PRs,
2+
# with the exclusions and accepted codes in .lychee.toml. Runs on PRs,
43
# pushes to main, weekly (links rot without a commit), and by hand.
54
name: Links
65
on:

‎.lychee.toml‎

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,10 @@ timeout = 30
99
max_concurrency = 16
1010

1111
# 429 is rate limiting, never a dead link. 403 is NOT accepted: no checked file
12-
# links to doi.org or a publisher site (IEEE, ACM, Springer, Elsevier, Wiley),
13-
# which answer 403 to anonymous clients such as CI runners. If such links appear,
14-
# exclude those hosts by name rather than accepting 403 for every host.
12+
# links to a publisher site (IEEE, ACM, Springer, Elsevier, Wiley), which answer
13+
# 403 to anonymous clients such as CI runners. If such links appear, exclude
14+
# those hosts by name rather than accepting 403 for every host. The doi.org
15+
# links are Zenodo DOIs, which resolve for anonymous clients.
1516
accept = ["200..=299", "429"]
1617

1718
# Skip links to localhost and private networks (the README's preview server).
@@ -20,20 +21,9 @@ exclude_all_private = true
2021
# Mail addresses are not checked.
2122
include_mail = false
2223

23-
# The landing page links the package docs relatively (`VisualGeometryToolkitCore/`).
24-
# Those directories are not in this repository: the Portal workflow builds them
25-
# into the published site, so check them there.
26-
remap = [
27-
'^file://.*/((VisualGeometryToolkit[A-Za-z]+|PoseLib)/?)$ https://visualgeometrytoolkit.github.io/$1',
28-
]
29-
3024
exclude = [
3125
'^mailto:',
3226
'^https?://(localhost|127\.0\.0\.1)',
33-
# Per-package release docs exist only once a package is tagged, after its
34-
# General registration (TagBot then deploys /<Package>/stable/). Expected 404s
35-
# until then: remove this exclusion once every package has a tagged release.
36-
'^https://visualgeometrytoolkit\.github\.io/VisualGeometryToolkit[A-Za-z]+/stable',
3727
# Codecov badges and app pages 404 for anonymous clients or time out.
3828
'^https://(app\.)?codecov\.io/',
3929
# CI status badges (GitHub renders them; anonymous fetches can be slow or 404

‎README.md‎

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@ To preview locally: `python -m http.server` in this directory, then open
1616

1717
`icons/` is generated by `tools/make_icons.py`; do not edit the SVGs by hand.
1818
The drawn icons are defined in the script. The LocalOptimizationDoneRight,
19-
RansacScoringDoneRight and BlobBoards icons are crops of those projects' landing
20-
heroes, read from checkouts under `~/src` (override with `VGT_SRC`):
19+
RANSACScoringDoneRight and BlobBoards icons are crops of those projects' landing
20+
heroes, read from checkouts under `~/src` (override with `VGT_SRC`; the
21+
RANSACScoringDoneRight checkout is the directory `RansacScoringDoneRight.jl`):
2122
`<repo>/docs/src/assets/landing/hero_*.png`. BlobBoards' hero is itself
2223
generated by `docs/make_hero.jl` in BlobBoards.jl (its configuration is
2324
recorded beside it in `docs/hero_board.json`).
@@ -28,10 +29,15 @@ recorded beside it in `docs/hero_board.json`).
2829
## Package documentation
2930

3031
`.github/workflows/portal.yml` builds the published site: this landing page at
31-
the root, plus the per-package Documenter sites aggregated by MultiDocumenter
32-
(`portal/make.jl`) under `/<Package>/` — the six monorepo packages from
33-
VisualGeometryToolkit.jl's `gh-pages`, and RansacScoringDoneRight,
34-
LocalOptimizationDoneRight and BlobBoards from their own `gh-pages` once those
35-
exist. It runs on push, nightly, by hand, and on the `docs-updated`
32+
the root, plus the six monorepo packages' Documenter sites, from
33+
VisualGeometryToolkit.jl's `gh-pages`, aggregated by MultiDocumenter
34+
(`portal/make.jl`) under `/<Package>/`. RANSACScoringDoneRight,
35+
LocalOptimizationDoneRight and BlobBoards keep their docs on their own project
36+
sites (`<project>.github.io`); the portal links to them, and their old
37+
`/<Project>/` paths are redirect pages. The landing page links each monorepo
38+
package's own Documenter site,
39+
`https://visualgeometrytoolkit.github.io/VisualGeometryToolkit.jl/<Package>/stable/`,
40+
and PanoramaStitching's at
41+
`https://visualgeometrytoolkit.github.io/PanoramaStitching.jl/dev/`. The Portal workflow runs on push, nightly, by hand, and on the `docs-updated`
3642
repository_dispatch from the monorepo's Docs workflow. Pages is served from
3743
the workflow (source: GitHub Actions), not from `main`.

‎icons/rsdr.svg‎

Lines changed: 1 addition & 1 deletion
Loading

0 commit comments

Comments
 (0)