Skip to content

docs: use rustdoc links in markdown#76

Merged
m4tx merged 7 commits intocot-rs:masterfrom
ElijahAhianyo:elijah/markdown-link-fix
Mar 13, 2026
Merged

docs: use rustdoc links in markdown#76
m4tx merged 7 commits intocot-rs:masterfrom
ElijahAhianyo:elijah/markdown-link-fix

Conversation

@ElijahAhianyo
Copy link
Copy Markdown
Contributor

@ElijahAhianyo ElijahAhianyo commented Mar 2, 2026

Link references in docs to their respective rustdoc links

@ElijahAhianyo ElijahAhianyo marked this pull request as ready for review March 5, 2026 19:37
@ElijahAhianyo ElijahAhianyo changed the title wip!: Use rustdoc links in markdown Use rustdoc links in markdown Mar 5, 2026
Copy link
Copy Markdown
Member

@m4tx m4tx left a comment

Choose a reason for hiding this comment

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

Amazing work and you linked everything like a true Wikipedian 😉 Like I mentioned during our meeting, I think there's not much of a point in fixing the old versions of the guide. Eventually, we'll want to remove them, as they get decreasingly irrelevant. Thanks for putting the extra effort regardless!

Please have a look at the comment I left, and after addressing it, this will be ready to be merged.

/// ```
///
/// ## Features
/// Reference to features should follow the format `features@featue_name`, where
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
/// Reference to features should follow the format `features@featue_name`, where
/// Reference to features should follow the format `features@feature_name`, where

typo.

Also, for consistency, I think this should be feature@, rather than features@, similarly to trait@, struct@, etc. What do you think?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

yeah we could do that. rustdocs uses features so I kind of just went with that so its much more intuitive with rustdocs, but I kind of agree feature is much more consistent

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Well, seems like at least there's no defined disambiguator for features, so we're free to choose either features or feature.

Thanks!

@ElijahAhianyo ElijahAhianyo requested a review from m4tx March 13, 2026 04:55
@m4tx m4tx changed the title Use rustdoc links in markdown docs: use rustdoc links in markdown Mar 13, 2026
@m4tx m4tx merged commit 6949083 into cot-rs:master Mar 13, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants