Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs: An attempt to fix broken links. #258

Merged
merged 1 commit into from
Jun 13, 2022

Conversation

saona-raimundo
Copy link
Contributor

Tries to fix #257 (fixes all but one).

There are still many links that I could not fix in the fluent crate, but they are not a problem in the fluent-bundle crate. I do not understand why these problems arise.

Relevant readings on Rust docs:

Useful tools

I can recommend trying cargo-deadlinks. It helped find broken links, even if the error message is not the best.

There are many links that I could not fix in the luent crate, but they are not a problem in the luent-bundle crate. I do not understand why these problems arise.

Relevant readings on Rust docs:
- Last addition to rustdoc capacities: https://rust-lang.github.io/rfcs/1946-intra-rustdoc-links.html
- Frontend/backend crates pattern: https://users.rust-lang.org/t/cross-crate-documentation-links-in-a-workspace/67588
- Help linking to an external crate (for which we want to link only on the documentation level): rust-lang/api-guidelines#186
- Open issue on how to do that: rust-lang/rust#74481
Copy link
Collaborator

@zbraniecki zbraniecki left a comment

Choose a reason for hiding this comment

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

thank you!

@zbraniecki zbraniecki merged commit df81ab8 into projectfluent:master Jun 13, 2022
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Many broken intra-doc links
2 participants