docs: add docs on using Lychee and fix lychee's build #939

JimMadge · 2025-09-25T09:54:27Z

Closes #935

Adds documentation for Lychee link check
Adds support for linking to targets (like /dir/page#my-target)
Fixes a number of links
Changes link checking to run on HTML output

…rs#889) * chore(package.json): add angular commit helper deps and script * test(link checking): add lychee configuration re all-contributors#852 * test(link check): add script to check links in Markdown source * fix: correct link to eslint commit convention * fix: correct bot usage image path * test: add mdx to fallback extentions * fix: remove broken link * test: check links internal to a page * test: add root dir to link checking This ensures links to an absolute path (starting with '/') are directed to the public directory. fix 852 * ci: add markdownlint dep and script * style: fix linting errors * ci: install deps for lint workflow * ci: add offline link check for PRs and push to main This workflow will only check links to local files and not make network requests. There should therefore be no false negatives and it is safer to use as a required CI item.

…contributors#895) * chore(branch rename): rename master --> main throughout so ci runs and docs are correct (all-contributors#890) chore(rename master to main branch): we renamed the master branch; this updates all actions & docs * docs: add JimMadge as a contributor for review (all-contributors#892) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Leah Wasser <[email protected]> * docs: add JHWelch as a contributor for doc (all-contributors#894) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>

docs: make index dynamic and add images docs: lint all docs and add markdown lint dep docs: lint Correct image path

docs:remove placeholder index page

…l-contributors#901) * docs(style): source gfonts poppins * docs(style): add custom style/ setup tailwind * docs(img): add and update images * docs(img): add and update images * docs(config): cleanup landing and config * chore(deps): update to support tailwind * chore(css): setup tailwind css * docs: add graphics for home page and style buttons * docs: add buttons * docs: missed a few more image updates * chore(deps): correct dependency location in package.lock * chore(clean): clean old files * chore: add poppins font license --------- Co-authored-by: Jim Madge <[email protected]>

…iew section (all-contributors#915) * docs: update images and document how to add content to our docs docs: update images and edit text for all intro pages docs: clean up all pages in the general overview section docs: add description for Ideas, projectManagement and promotion (all-contributors#829) docs: ✏️ Add dark mode README logo (all-contributors#741) Co-authored-by: Leah Wasser <[email protected]> Co-authored-by: Jim Madge <[email protected]> * enh(image): bring in dark mode compatible logo * docs: tidy adding images section Move path alias section up and adjust Apply suggestions from code review Co-authored-by: Jim Madge <[email protected]> * style: linting fixes for emoji table and other content --------- Co-authored-by: Jim Madge <[email protected]> Co-authored-by: Jim Madge <[email protected]>

…s#914) * docs: get docs online via github pages new branch * chore: set site and base according to astro docs Astro docs: https://docs.astro.build/en/guides/deploy/github/#how-to-deploy suggest how to specifiy the site url and base for GitHub pages. --------- Co-authored-by: Jim Madge <[email protected]>

…utors#924)

* ci: correct workflow file format 🤦 * ci: add root directory to offline link check This ensures that the link checkers knows where to look for absolute links.

…ocumentation (all-contributors#919) * docs: update images and document how to add content to our docs docs: update images and edit text for all intro pages docs: clean up all pages in the general overview section docs: add description for Ideas, projectManagement and promotion (all-contributors#829) docs: ✏️ Add dark mode README logo (all-contributors#741) Co-authored-by: Leah Wasser <[email protected]> Co-authored-by: Jim Madge <[email protected]> * enh(image): bring in dark mode compatible logo * docs: tidy adding images section Move path alias section up and adjust Apply suggestions from code review Co-authored-by: Jim Madge <[email protected]> * style: linting fixes for emoji table and other content * docs: fix links and breakouts in bot section * Apply suggestions from code review Co-authored-by: Jim Madge <[email protected]> --------- Co-authored-by: Jim Madge <[email protected]> Co-authored-by: Jim Madge <[email protected]>

docs: add netlify badge for open source plan

…butors#933) docs(styles): apply stylesheets globally docs: document custom styles

…ributors#931) docs: fix links and images on last sections

…main (all-contributors#929) * chore(ci): add dependabot config for actions (all-contributors#865) * chore(ci): bump actions/checkout from 3 to 5 (all-contributors#883) Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 5. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](actions/checkout@v3...v5) --- updated-dependencies: - dependency-name: actions/checkout dependency-version: '5' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(ci): bump actions/setup-node from 3 to 4 (all-contributors#882) Bumps [actions/setup-node](https://github.com/actions/setup-node) from 3 to 4. - [Release notes](https://github.com/actions/setup-node/releases) - [Commits](actions/setup-node@v3...v4) --- updated-dependencies: - dependency-name: actions/setup-node dependency-version: '4' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * chore(ci): bump actions/upload-pages-artifact from 3 to 4 (all-contributors#881) * chore(ci): bump actions/upload-pages-artifact from 3 to 4 Bumps [actions/upload-pages-artifact](https://github.com/actions/upload-pages-artifact) from 3 to 4. - [Release notes](https://github.com/actions/upload-pages-artifact/releases) - [Commits](actions/upload-pages-artifact@v3...v4) --- updated-dependencies: - dependency-name: actions/upload-pages-artifact dependency-version: '4' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]> * Update .github/workflows/build-website.yml * chore(ci): update actions --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Leah Wasser <[email protected]> * chore(branch rename): rename master --> main throughout so ci runs and docs are correct (all-contributors#890) chore(rename master to main branch): we renamed the master branch; this updates all actions & docs * docs: ✏️ fix links to doc site and small bug in footer.js (all-contributors#871) * docs: ✏️ fix links to doc site and small bug in footer.js This change fixes an error in the footer and also updates some broken links. ✅ Closes: 870 * Update website/static/index.html Co-authored-by: Leah Wasser <[email protected]> * Update docs/overview.md --------- Co-authored-by: Jim Madge <[email protected]> * docs: add JimMadge as a contributor for review (all-contributors#892) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Leah Wasser <[email protected]> * docs: add JHWelch as a contributor for doc (all-contributors#894) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add lwasser as a contributor for review (all-contributors#897) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add JimMadge as a contributor for infra (all-contributors#896) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Jim Madge <[email protected]> * docs: ✏️ Add dark mode README logo (all-contributors#741) Co-authored-by: Leah Wasser <[email protected]> Co-authored-by: Jim Madge <[email protected]> * docs: add RichLewis007 as a contributor for bug, and doc (all-contributors#906) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add parthamk as a contributor for doc (all-contributors#909) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add rebeccaringuette as a contributor for ideas (all-contributors#910) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * Change build branch from 'master' to 'docs-upgrade' * docs: add description for Ideas, projectManagement and promotion (all-contributors#829) * docs: add KhushiPandey8 as a contributor for doc (all-contributors#918) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add lwasser as a contributor for doc (all-contributors#921) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: add JimMadge as a contributor for doc (all-contributors#922) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * docs: linting fix * docs: remove last docusaurus files * docs: update * chore: fix linting step to handle mdx * chore: lint * fix: links --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Jim Madge <[email protected]> Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Jim Madge <[email protected]> Co-authored-by: Jordan Welch <[email protected]> Co-authored-by: Reshama Shaikh <[email protected]>

netlify · 2025-09-25T09:56:25Z

❌ Deploy Preview for all-contributors failed.

Name	Link
🔨 Latest commit	`73e09ce`
🔍 Latest deploy log	https://app.netlify.com/projects/all-contributors/deploys/68e518f2c57efd000808346f

This seems to create a recursion

JimMadge · 2025-09-27T19:29:06Z

@lwasser I think this is finally ready for you to take a look 😮‍💨.

There actually did seem to be a few broken links. Because, unlike most times in Markdown where links are relative to the file, in Astro everything is relative to the root of the site.

It would be worth checking locally to check that links work. It seems fine on my end.

lwasser · 2025-10-01T16:02:42Z

@JimMadge, my apologies for the silence. I have a workshop tomorrow, and I experienced unexpected staff turnover this week, so my week has become extremely busy. I'll look at this on the weekend! 🚀

JimMadge · 2025-10-02T09:21:19Z

@JimMadge, my apologies for the silence. I have a workshop tomorrow, and I experienced unexpected staff turnover this week, so my week has become extremely busy. I'll look at this on the weekend! 🚀

No problem. I've had a few busy weeks too 😆. I've been wanting to get deploying to Netlify for ages but not found the time.

lwasser · 2025-10-04T18:24:46Z

hey @JimMadge 👋🏻 !! I hope you're having a nice weekend. I am not sure if you intended to do this but this pr is going to docs-upgrade. But we have already merge the docs into main and the docs-upgrade branch is now a bit behind (I will archive it). Can you please rebase against the main branch and submit this pr there? I will go ahead and review now but that rebase is needed as if i try to switch the pr to main branch, it moves to over 100+ files in the pr that were modified and i'm sure that is just because the branch is dated.

src/content/docs/project/contribute.mdx

lwasser

@JimMadge This is great! Thank you!
I've suggested some changes that you can accept or not! I think the big issue is that this PR needs to go to the main branch. Once the PR is set up and comments are resolved, we can merge!

Co-authored-by: Leah Wasser <[email protected]>

JimMadge · 2025-10-07T18:01:36Z

Thanks @lwasser. I like you suggestions. I've merged in the changes from main and changed the target so hopefully this is ready now.

lwasser

Fantastic. Thank you again for this! Let's go ahead and merge it. Netlify is leaving angry ❌ on our pr's, but I'm going to ignore them for now. 🙃

flpm and others added 28 commits September 1, 2025 16:36

docs: remove Docusaurus website and docs

a1fb93c

docs: remove netlify.toml

3c93bed

docs: add astro config

ef1289f

docs: add astro / starlight docs source

77211de

docs: add public all-contrib static files

43ba723

docs: dependencies, update package.json

33e1cc9

docs: added favicons and related images

8ab31d5

docs update node version in .nvmrc; remove .astro; fix .gitignore

009fa31

docs: small updates to github CI

93be922

docs: update .gitignore with more astro related files

c34a2b4

docs: small updates to clarify config

5b9dba5

docs: add landing page to astro documentation (all-contributors#887)

42f1b66

docs: make index dynamic and add images docs: lint all docs and add markdown lint dep docs: lint Correct image path

docs:remove placeholder index page (all-contributors#899)

8594016

docs:remove placeholder index page

docs(fix basurl): update baseurl to support github pages (all-contrib…

eac226d

…utors#924)

chore(ci): Fix offline link check (all-contributors#923)

f832600

* ci: correct workflow file format 🤦 * ci: add root directory to offline link check This ensures that the link checkers knows where to look for absolute links.

docs: add Netlify badge to home page (all-contributors#927)

86d1137

docs: add netlify badge for open source plan

docs: import styles globally rather than inline in a file (all-contri…

a2a5c47

…butors#933) docs(styles): apply stylesheets globally docs: document custom styles

Docs: Fix images and links in the last sections of the docs (all-cont…

80c66fa

…ributors#931) docs: fix links and images on last sections

docs: remove bold around code block

86c38cf

docs: remove some formatting

a711e5e

test: add mdx files to link check scripts

099c044

JimMadge changed the base branch from main to docs-upgrade September 25, 2025 09:54

JimMadge added 3 commits September 27, 2025 20:18

docs: update link check docs

26b7135

ci: build site before link check

3b73d7f

ci: remove remap from workflow command

7b1f146

This seems to create a recursion

JimMadge marked this pull request as ready for review September 27, 2025 19:27

JimMadge requested a review from lwasser September 27, 2025 19:27

lwasser changed the title ~~Add Lychee docs~~ docs: add docs on using Lychee Oct 4, 2025

lwasser changed the title ~~docs: add docs on using Lychee~~ docs: add docs on using Lychee and fix lychee's build Oct 4, 2025

lwasser changed the base branch from docs-upgrade to main October 4, 2025 18:22

lwasser changed the base branch from main to docs-upgrade October 4, 2025 18:22