sway icon indicating copy to clipboard operation
sway copied to clipboard

[forc-doc] Add a link to the docs hub in the standard library

Open sdankel opened this issue 2 years ago • 7 comments

When clicking into an item in the sdt library docs, I would expect to see a navigation sidebar with all of the links in the docs website, similar to https://doc.rust-lang.org/

sdankel avatar Feb 27 '23 22:02 sdankel

Hey Sophie, the link you provided is the rust language official website. I've mentioned before I think we should have a hub like that site where std, the sway book and the reference could be linked as well as things like Awesome Sway, etc. There is a navigation sidebar which will have a shortcut to reference parts of the doc page and help navigate to the previous module. Would you mind providing some more detail on how you would like this to look?

eureka-cpu avatar Feb 28 '23 04:02 eureka-cpu

I think adding the link to the docs hub in the root module doc comment of the standard library would be sufficient. That way we aren't always including a link to the docs hub in the docs produced by forc doc directly where it isn't warranted.

eureka-cpu avatar Sep 21 '23 18:09 eureka-cpu

Austin suggested we could place a link to the sway documentation portal when the rustdoc book is.

Screenshot 2023-09-29 at 10 25 55 am

JoshuaBatty avatar Sep 29 '23 00:09 JoshuaBatty

Good day, can I contribute to this one? Would be quite the welcome experience for me

Samaro1 avatar Apr 26 '25 20:04 Samaro1

@Samaro1 sure you're welcome to have a go.

JoshuaBatty avatar Apr 28 '25 00:04 JoshuaBatty

@JoshuaBatty it's not yet assigned to me

Samaro1 avatar Apr 28 '25 10:04 Samaro1

i will like to work on this. ETA 24 hours

Sendi0011 avatar Jun 05 '25 11:06 Sendi0011