Skip to content
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

use absolute links in SUMMARY.md #4067

Closed
wants to merge 1 commit into from

Conversation

cryptoni9n
Copy link
Collaborator

@cryptoni9n cryptoni9n commented Nov 12, 2024

fixes #4060

from inscriptions/delegate.md to /inscriptions/delegate.md for links under inscriptions, runes, guides and bounty folders.

@cryptoni9n
Copy link
Collaborator Author

cryptoni9n commented Nov 12, 2024

Hi @raphjaph - I'm not sure how to, or if I am able to resolve the conflicts. Was able to resolve conflicts, but failing the doc build.

Copy link
Collaborator Author

@cryptoni9n cryptoni9n left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

first commit didn't have the new link for spliiting.md - added with a subsequent commit but PR stuck in conflict.

@raphjaph
Copy link
Collaborator

The problem is something with github actions because if you run it locally it works fine. @cryptoni9n try running just serve-docs to see it locally. You might need to install some things, see translation section of the README

@cryptoni9n
Copy link
Collaborator Author

The problem is something with github actions because if you run it locally it works fine. @cryptoni9n try running just serve-docs to see it locally. You might need to install some things, see translation section of the README

thanks Raph - have been struggling trying to get just working on my windows machine. I believe it's installed correctly, but can't build or serve docs, keep getting:

$ just --version
just 1.36.0

$ just build-docs
error: Recipe `build-docs` failed with exit code 101

$ just serve-docs
error: Recipe `build-docs` failed with exit code 101

@raphjaph
Copy link
Collaborator

raphjaph commented Nov 12, 2024

Do any other just recipes work?

Try just fmt for example

@raphjaph
Copy link
Collaborator

Otherwise try the command manually without the languages:

mdbook build docs -d build
python3 -m http.server --directory docs/build/html --bind 127.0.0.1 8080

@raphjaph
Copy link
Collaborator

Oh and don't try it on this branch, it doesn't work. Try master

@cryptoni9n
Copy link
Collaborator Author

Do any other just recipes work?

Try just fmt for example

yes, that one works and shows the green dot with message "command executed x secs ago and took 1.074s":

$ just fmt
cargo fmt --all

If I try and run the mdbook command by itself:

$ mdbook --version
mdbook v0.4.42 

$ mdbook build docs -d build

it shows the red dot and says "command executed x secs ago, took 46ms and failed (Error Code 101)"

@cryptoni9n
Copy link
Collaborator Author

Oh and don't try it on this branch, it doesn't work. Try master

getting all the same errors from master branch :/

anyway, were you saying that the github actions problem is what is causing the CI failure? Or that it is what is causing the issue on docs.ordinals.com?

@raphjaph
Copy link
Collaborator

Hmm, seems to Windows stuff.

This PR doesn't work because we need to use relative paths in the SUMMARY.md, see here: https://github.com/rust-lang/mdBook/blob/master/guide/src/format/summary.md

You are on the right track though that the rendered page uses relative paths incorrectly.

I'll close this for now and continue discussion in your issue

@raphjaph raphjaph closed this Nov 13, 2024
@cryptoni9n cryptoni9n deleted the fix-doc-links branch November 13, 2024 14:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

404 issue with links on docs.ordinals.com
2 participants