-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Docs: "Improving the GNU compatibility" section links in Contributing are broken #7201
Comments
I managed to build the documentation locally and it seems to work okay. $ cargo build --features uudoc
$ target/debug/uudoc
$ cargo install mdbook --locked
$ cd docs
$ mdbook serve --open I don't see anywhere that the CI builds this so I'm assuming its manually done? The missing files seem to be from |
I found this section https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#creating-a-custom-github-actions-workflow-to-publish-your-site It looks like we might require custom steps to build and it would require adminstration setup to make it work successfully. |
Okay I might be able to get CI steps to work on my fork for testing purposes, to be continued... |
Placing this here for now as a placeholder, I can test this later.
name: github pages
on:
push:
branches:
- main
pull_request:
jobs:
deploy:
runs-on: ubuntu-24.04
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- uses: actions/checkout@v4
- name: Setup mdBook
uses: peaceiris/actions-mdbook@v2
with:
mdbook-version: 'latest'
- run:
rustup update stable && rustup default stable
cargo install mdbook mdbook-toc --locked
cargo build --release --features "uudoc"
target/release/uudoc
mdbook build docs
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.ref == 'refs/heads/main' }}
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./book |
All links in this page pointing to
DEVELOPMENT.html
show a 404 page.https://uutils.github.io/coreutils/docs/contributing.html#improving-the-gnu-compatibility
DEVELOPMENT.html doesn't seem to exist.
The text was updated successfully, but these errors were encountered: