-
Notifications
You must be signed in to change notification settings - Fork 1.7k
chore(ci for docs): Get docs online via github pages #914
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Right now the website that is online is broken - only the landing page works. This pr will update the site (for github pages only) to build from docs-upgrade. https://all-contributors.github.io/all-contributors/ Because the site is broken, I suggest that we replace it with a working version. In that version some images and links might be broken on some pages. See #915 as I did fix the entire first section (and it won't take long to now do the rest with the aliases in place). So we could merge this, and if we are happy with it as is, merge the entire docs-upgrade branch into main and continue the work to fix things there directly (via pr's). If we get to that point then we can
just an idea to get things online! It is bothering me how broken the sites are now that are online. We are further along in that regard in this dev branch. |
Maybe this is to do with redirects? For example, the docs link on the landing page goes to Actually, the base URL may also be wrong. Because the site is at |
It definitely has to do with the base url. If we keep the repo name as is it will be all-contributors/all-contributors! I think that we are so far along in the astro site that it makes the most sense to focus on getting this site online rather than trying to fix the dated Docusaurus site at this point. We could have the entire site live with a few small prs!! The pages all work, there are some images to fix. This will be much less effort to focus on what is so close to being fully ready to go. |
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.
Yes - The current GitHub Pages site is built via Docusaurus and is broken - so broken! It has a custom index.html page with a manual link to the docs. It's actually 2 sites - the index page and then the docs! The current GitHub Pages site that we would build if this is merged works 🚀 So I'm suggesting that we merge this pr and my other one (when everyone is happy with it) as all of the pages will build. I will rename the repo to avoid all-contributors/all-contributors in the url, we can then merge to main one we see it builds as expected here and we will have a working site! There may be a few broken links, but I can fix those - and I think a few broken links is better than the entire documentation site not being accessible! That's just my thought. im trying to balance time, and users needing docs (which brings a tiny bit of urgency to our work) So merging this will result in a better site than what is live now is the bottom line. Then we can proceed with netlify knowing the docs are online, translations, etc. |
@JimMadge, thank you for the URL fix!! I am going to merge this now and then I may make some quick fixes if the website doesn't build as expected. But it will all go into the |
…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]>
) * docs: remove Docusaurus website and docs * docs: remove netlify.toml * docs: add astro config * docs: add astro / starlight docs source * docs: add public all-contrib static files * docs: dependencies, update package.json * docs: added favicons and related images * docs update node version in .nvmrc; remove .astro; fix .gitignore * docs: small updates to github CI * docs: update .gitignore with more astro related files * docs: small updates to clarify config * chore(link checker): Move to Lychee for link checking (#889) * chore(package.json): add angular commit helper deps and script * test(link checking): add lychee configuration re #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. * docs: add landing page to astro documentation (#887) 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 (#899) docs:remove placeholder index page * docs: style landing page, add branded fonts and colors & tailwind (#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]> * docs: add documentation for mdx pages and update images for the overview section (#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 (#829) docs: ✏️ Add dark mode README logo (#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]> * chore(ci for docs): Get docs online via github pages (#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]> * docs(fix basurl): update baseurl to support github pages (#924) * chore(ci): Fix offline link check (#923) * 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: update images and breakout links for the "bot" section of the documentation (#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 (#829) docs: ✏️ Add dark mode README logo (#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 to home page (#927) docs: add netlify badge for open source plan * docs: import styles globally rather than inline in a file (#933) docs(styles): apply stylesheets globally docs: document custom styles * Docs: Fix images and links in the last sections of the docs (#931) docs: fix links and images on last sections * chore: add merge commit to handle merge conflicts when we merge into main (#929) * chore(ci): add dependabot config for actions (#865) * chore(ci): bump actions/checkout from 3 to 5 (#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 (#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 (#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 (#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 (#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 (#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 (#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 (#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 (#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 (#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 (#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 (#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 (#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 (#829) * docs: add KhushiPandey8 as a contributor for doc (#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 (#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 (#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]> * chore: add dot files to ignore * Apply suggestion from @JimMadge Co-authored-by: Jim Madge <[email protected]> * chore: linting chore: docusaurus came back --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Felipe Moreno <[email protected]> Co-authored-by: Jim Madge <[email protected]> Co-authored-by: Jim Madge <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Jordan Welch <[email protected]> Co-authored-by: Reshama Shaikh <[email protected]>
* docs: remove Docusaurus website and docs * docs: remove netlify.toml * docs: add astro config * docs: add astro / starlight docs source * docs: add public all-contrib static files * docs: dependencies, update package.json * docs: added favicons and related images * docs update node version in .nvmrc; remove .astro; fix .gitignore * docs: small updates to github CI * docs: update .gitignore with more astro related files * docs: small updates to clarify config * chore(link checker): Move to Lychee for link checking (#889) * chore(package.json): add angular commit helper deps and script * test(link checking): add lychee configuration re #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. * docs(readme): sync readme file in docs upgrade branch with main (#895) * chore(branch rename): rename master --> main throughout so ci runs and docs are correct (#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 (#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 (#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: add landing page to astro documentation (#887) 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 (#899) docs:remove placeholder index page * docs: style landing page, add branded fonts and colors & tailwind (#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]> * docs: add documentation for mdx pages and update images for the overview section (#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 (#829) docs: ✏️ Add dark mode README logo (#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]> * chore(ci for docs): Get docs online via github pages (#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]> * docs(fix basurl): update baseurl to support github pages (#924) * chore(ci): Fix offline link check (#923) * 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: update images and breakout links for the "bot" section of the documentation (#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 (#829) docs: ✏️ Add dark mode README logo (#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 to home page (#927) docs: add netlify badge for open source plan * docs: import styles globally rather than inline in a file (#933) docs(styles): apply stylesheets globally docs: document custom styles * Docs: Fix images and links in the last sections of the docs (#931) docs: fix links and images on last sections * chore: add merge commit to handle merge conflicts when we merge into main (#929) * chore(ci): add dependabot config for actions (#865) * chore(ci): bump actions/checkout from 3 to 5 (#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 (#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 (#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 (#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 (#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 (#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 (#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 (#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 (#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 (#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 (#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 (#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 (#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 (#829) * docs: add KhushiPandey8 as a contributor for doc (#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 (#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 (#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]> * docs: remove bold around code block * docs: remove some formatting * test: add mdx files to link check scripts * docs: add docs for using Lychee * test: exclude astro aliases from link check * ci: check mdx files for links * WIP: fix links in mdx files * Revert "WIP: fix links in mdx files" This reverts commit 92aa7b5. * test: run link check on HTML * Update links * docs: add automatic links to headings * test: correct link check scripts * docs: fix links to fragments * docs: correct and exclude links to fragments The server redirects these correctly, however they don't match file paths so the link checker fails * docs: update link check docs * ci: build site before link check * ci: remove remap from workflow command This seems to create a recursion * Update src/content/docs/project/contribute.mdx Co-authored-by: Leah Wasser <[email protected]> * Update src/content/docs/project/contribute.mdx Co-authored-by: Leah Wasser <[email protected]> * Update src/content/docs/project/contribute.mdx Co-authored-by: Leah Wasser <[email protected]> * Update src/content/docs/project/contribute.mdx Co-authored-by: Leah Wasser <[email protected]> * Update src/content/docs/project/contribute.mdx Co-authored-by: Leah Wasser <[email protected]> --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Felipe Moreno <[email protected]> Co-authored-by: Leah Wasser <[email protected]> Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Jordan Welch <[email protected]> Co-authored-by: Reshama Shaikh <[email protected]>
Currently, the documentation is building from main branch which means that it is broken. I suggest (but want feedback) that is we merge this PR, we can test the docs live from the docs-upgrade branch. And moving forward, we can then merge into main sooner.
This works here: https://www.leahwasser.com/all-contributors/
What:
I think because the docs are so broken online, it might be better to get the new site online sooner with all of the pages working (but broken links and images). Then we can focus the next pr's on fixing image links (which should not take too much time).
Why:
Here, I modified CI build to deploy to github pages from docs-upgrade rather than main. I kept all-contributors/ as a baseurl because we should wait to ensure the page launches from github pages before fully commiting to updating main and renaming the repo (which will break netlify fully).
How:
I am opening this as a quick draft and will open a discussion about it next.
Bot Usage