docs: add documentation for mdx pages and update images for the overview section#915
Conversation
There was a problem hiding this comment.
This page is actually for maintainers - so i moved it to the project documentation section. It doesn't make sense for a user to see it in the overview.
JimMadge
left a comment
There was a problem hiding this comment.
Looks good.
I made a few changes as commits because I thought it was easier than review comments. So please look at those and say if you don't agree.
One problem is the hero images hasn't been checked in to the repo.
Thanks @JimMadge !! I'm curious about the hero issues as it should render. It lives already in docs-upgrade 🚀, but I may have missed something. Everything else has been fixed!! The one nice thing about Astro is that if it can't find an image, the build actually fails. I actually like that for local dev as it is a sanity check that forces a clean build. |
|
I just pushed another commit to fix the linting issues ! |
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 <leah@pyopensci.org> Co-authored-by: Jim Madge <jim@jmadge.com>
Move path alias section up and adjust Apply suggestions from code review Co-authored-by: Jim Madge <jim+github@jmadge.com>
6d6f6a6 to
cc945eb
Compare
|
@all-contributors please add @lwasser for docs |
|
I've put up a pull request to add @lwasser! 🎉 |
|
@all-contributors please add @JimMadge for docs |
|
I've put up a pull request to add @JimMadge! 🎉 |
Oh that's so curious. Please let me know if you see that issue again!! thank you for merging this!! 🚀 |
…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 <leah@pyopensci.org> Co-authored-by: Jim Madge <jim@jmadge.com> * 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 <jim+github@jmadge.com> * style: linting fixes for emoji table and other content --------- Co-authored-by: Jim Madge <jim@jmadge.com> Co-authored-by: Jim Madge <jim+github@jmadge.com>
) * 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 <jim@jmadge.com> * 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 <leah@pyopensci.org> Co-authored-by: Jim Madge <jim@jmadge.com> * 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 <jim+github@jmadge.com> * style: linting fixes for emoji table and other content --------- Co-authored-by: Jim Madge <jim@jmadge.com> Co-authored-by: Jim Madge <jim+github@jmadge.com> * 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 <jim@jmadge.com> * 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 <leah@pyopensci.org> Co-authored-by: Jim Madge <jim@jmadge.com> * 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 <jim+github@jmadge.com> * 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 <jim+github@jmadge.com> --------- Co-authored-by: Jim Madge <jim@jmadge.com> Co-authored-by: Jim Madge <jim+github@jmadge.com> * 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] <support@github.com> 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] <support@github.com> 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] <support@github.com> * Update .github/workflows/build-website.yml * chore(ci): update actions --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Leah Wasser <leah@pyopensci.org> * 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 <leah@pyopensci.org> * Update docs/overview.md --------- Co-authored-by: Jim Madge <jim+github@jmadge.com> * 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 <leah@pyopensci.org> * 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 <jim@jmadge.com> * docs: ✏️ Add dark mode README logo (#741) Co-authored-by: Leah Wasser <leah@pyopensci.org> Co-authored-by: Jim Madge <jim@jmadge.com> * 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] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Jim Madge <jim+github@jmadge.com> Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Jim Madge <jim@jmadge.com> Co-authored-by: Jordan Welch <JordanHWelch@gmail.com> Co-authored-by: Reshama Shaikh <reshama.stat@gmail.com> * chore: add dot files to ignore * Apply suggestion from @JimMadge Co-authored-by: Jim Madge <jim+github@jmadge.com> * chore: linting chore: docusaurus came back --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Felipe Moreno <felipe@flpm.dev> Co-authored-by: Jim Madge <jim@jmadge.com> Co-authored-by: Jim Madge <jim+github@jmadge.com> 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 <JordanHWelch@gmail.com> Co-authored-by: Reshama Shaikh <reshama.stat@gmail.com>
* 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 <leah@pyopensci.org> * 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 <jim@jmadge.com> * 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 <leah@pyopensci.org> Co-authored-by: Jim Madge <jim@jmadge.com> * 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 <jim+github@jmadge.com> * style: linting fixes for emoji table and other content --------- Co-authored-by: Jim Madge <jim@jmadge.com> Co-authored-by: Jim Madge <jim+github@jmadge.com> * 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 <jim@jmadge.com> * 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 <leah@pyopensci.org> Co-authored-by: Jim Madge <jim@jmadge.com> * 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 <jim+github@jmadge.com> * 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 <jim+github@jmadge.com> --------- Co-authored-by: Jim Madge <jim@jmadge.com> Co-authored-by: Jim Madge <jim+github@jmadge.com> * 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] <support@github.com> 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] <support@github.com> 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] <support@github.com> * Update .github/workflows/build-website.yml * chore(ci): update actions --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Leah Wasser <leah@pyopensci.org> * 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 <leah@pyopensci.org> * Update docs/overview.md --------- Co-authored-by: Jim Madge <jim+github@jmadge.com> * 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 <leah@pyopensci.org> * 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 <jim@jmadge.com> * docs: ✏️ Add dark mode README logo (#741) Co-authored-by: Leah Wasser <leah@pyopensci.org> Co-authored-by: Jim Madge <jim@jmadge.com> * 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] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Jim Madge <jim+github@jmadge.com> Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: Jim Madge <jim@jmadge.com> Co-authored-by: Jordan Welch <JordanHWelch@gmail.com> Co-authored-by: Reshama Shaikh <reshama.stat@gmail.com> * 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 <leah@pyopensci.org> * Update src/content/docs/project/contribute.mdx Co-authored-by: Leah Wasser <leah@pyopensci.org> * Update src/content/docs/project/contribute.mdx Co-authored-by: Leah Wasser <leah@pyopensci.org> * Update src/content/docs/project/contribute.mdx Co-authored-by: Leah Wasser <leah@pyopensci.org> * Update src/content/docs/project/contribute.mdx Co-authored-by: Leah Wasser <leah@pyopensci.org> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Felipe Moreno <felipe@flpm.dev> Co-authored-by: Leah Wasser <leah@pyopensci.org> 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 <JordanHWelch@gmail.com> Co-authored-by: Reshama Shaikh <reshama.stat@gmail.com>
Addressed (but doesn't close) #912
This PR:
What:
Hopefully, these docs will make it easier for more people to contribute to the docs if they wish to!
Why:
How:
Checklist:
This is a start at docs. I think we also should open an issue about documentation deployment and infrastructure that talks about github pages (netlify) and crowdin links. that will be a high level infrastructure page.