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 API documentation front page styleguide #1687

Closed
wants to merge 26 commits into from
Closed
Changes from 1 commit
Commits
Show all changes
26 commits
Select commit Hold shift click to select a range
c43e66a
Add API documentation front page styleguide
Jul 25, 2016
5c84df4
Update formatting (thanks vim)
Jul 25, 2016
09b551e
More formatting updates
Jul 25, 2016
d94849b
Cleans up links and formatting.
peschkaj Aug 19, 2016
b4ff67a
Merge pull request #1 from peschkaj/front_page_styleguide
Aug 19, 2016
74c84e9
How we teach front page documentation
dtolnay May 7, 2017
14b424d
Clean up trailing whitespace
dtolnay May 7, 2017
5e7544d
Mention readme in the summary
dtolnay May 8, 2017
4754fdd
Tie this to 2017 roadmap
dtolnay May 8, 2017
f278e48
Fold examples under each capability
dtolnay May 8, 2017
0192c10
Brainstorm some alternatives and open questions
dtolnay May 8, 2017
565d2c1
Where to put license boilerplate
dtolnay May 8, 2017
87f3972
Where to explain getting help
dtolnay May 8, 2017
ec3e74f
Rewrap consistently
dtolnay May 8, 2017
8793929
Factor links out of the paragraphs
dtolnay May 8, 2017
6d6c1a8
Rethink the purpose of the introduction
dtolnay May 8, 2017
3e5662b
Multi crate guidance
dtolnay May 8, 2017
7b0bd87
Example budget
dtolnay May 8, 2017
feb4972
Migration notes
dtolnay May 8, 2017
0cb8cca
Crystalize the purpose of the first example
dtolnay May 8, 2017
8b54517
Preserve backticks in the original
dtolnay May 8, 2017
8636aeb
This example prints to stdout as a side effect
dtolnay May 8, 2017
509a323
Wording
dtolnay May 8, 2017
708f120
Smaller headings in the quoted text
dtolnay May 8, 2017
7348e61
Readme unresolved question
dtolnay May 8, 2017
4cce1e2
Where to put capability examples
dtolnay May 8, 2017
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
More formatting updates
  • Loading branch information
Jonathan Turner committed Jul 25, 2016
commit 09b551ef5cd787d4f79dee5ba663bebe7fd24acd
2 changes: 1 addition & 1 deletion text/0000-api-doc-frontpage-styleguide.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 133,7 @@ Here's a good example from the 'rand' crate:
Sample code for each crate capability should be as simple as possible and side effect free. In the
rand crate, thread safe RNG is demonstrated 5 lines of code:
Copy link

Choose a reason for hiding this comment

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

s/rand/rand or a link?

Copy link

Choose a reason for hiding this comment

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

s/demonstrated 5/demonstrated in 5


```
```rust
use rand::Rng;

let mut rng = rand::thread_rng();
Expand Down