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

Add hyperlinks to docs #11

Closed
zzmp opened this issue Jun 13, 2014 · 4 comments
Closed

Add hyperlinks to docs #11

zzmp opened this issue Jun 13, 2014 · 4 comments

Comments

@zzmp
Copy link
Member

zzmp commented Jun 13, 2014

There should be easier docs navigation than provided for within rustdoc, using the same linking scheme.

Any time we reference another trait/struct/fn in our /// comments, we should use markdown to link them correctly to their doc like so:

Furnace

The relative link is dependent on where we are in the file structure (look at generated docs for more details).

@reem
Copy link
Member

reem commented Jun 16, 2014

We should write a tool to automate this.

@zzmp
Copy link
Member Author

zzmp commented Jun 16, 2014

bash? Maybe templating (ERB-style)? If we use templating, we can make it a grunt-like task, but we might want to do it in bash or another scripting language so we can stick it in our configure file - just have it be done as part of configure, so we never have to commit the changes.

Just ideas..

@reem
Copy link
Member

reem commented Jun 16, 2014

I agree. If someone wanted to become a sed guru that would be cool but otherwise I think we might need something a bit more powerful (I'm thinking lo-dash template and gulp).

@reem
Copy link
Member

reem commented Jul 22, 2014

This is more trouble than it's worth. Closing.

@reem reem closed this as completed Jul 22, 2014
phlmn pushed a commit to phlmn/iron that referenced this issue Oct 19, 2018
This makes sure all requests have valid urls. Fixes iron#11
phlmn pushed a commit to phlmn/iron that referenced this issue Oct 19, 2018
(doc) Removed ServerT from README.
phlmn pushed a commit to phlmn/iron that referenced this issue Oct 19, 2018
phlmn pushed a commit to phlmn/iron that referenced this issue Oct 18, 2019
Format strings support colors and terminal attributes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants