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.

Sign up for GitHub

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

Jump to bottom

Add API documentation front page styleguide #1687

Closed
wants to merge 26 commits into from
Closed

Add API documentation front page styleguide #1687

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
Smaller headings in the quoted text
  • Loading branch information
@dtolnay
dtolnay committed May 8, 2017
commit 708f120c6875f577f8e9a76bb64a21b9e9d816a7
4 changes: 2 additions & 2 deletions text/0000-api-doc-frontpage-styleguide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 145,7 @@ begin to combine capabilities.

Here is a good example from the `rand` crate:

> ## Thread-local RNG
> ### Thread-local RNG
>
> There is built-in support for a RNG associated with each thread stored in
> thread-local storage. This RNG can be accessed via `thread_rng`, or used
Expand All @@ -154,7 154,7 @@ Here is a good example from the `rand` crate:
> and will automatically reseed itself from this source after generating 32 KiB
> of random data.
>
> ## Cryptographic security
> ### Cryptographic security
>
> An application that requires an entropy source for cryptographic purposes must
> use `OsRng`, which reads randomness from the source that the operating system
Expand Down