mirror of
https://github.com/rust-lang/rust.git
synced 2026-03-20 00:15:17 +00:00
Page:
Note wiki conventions
Pages
Anticipated breaking changes during 1.0 alpha
Community User Groups, Meetups, and Events
Community libraries
Doc continuous integration
Doc how to install an unofficial nightly for Windows
Doc Emacs Support
Doc FAQ Cheatsheet
Doc building for android
Doc building for ios
Doc detailed release notes
Doc examples
Doc friends of the tree
Doc language faq
Doc lowlevel details
Doc packages, editors, and other tools
Doc releases
Doc under construction FAQ
Doc vim support
Docs project structure
Docs
Games written in Rust
Home
Howto submit a rust bug report
IRC notifications channel
Lib datetime
Lib fmt
Lib html
Lib io
Lib rand
Lib re
Library editing
Libs
Meeting API review 2014 06 23
Meeting RFC triage 2014 06 19
Mixed language link time optimization
Note Building Rust Before 0.8 on Windows Systems
Note 0.5 priorities
Note Intrinsics
Note Rust performance fixes
Note bors usage
Note buildbots
Note code review
Note compiler snapshots
Note core team
Note development policy
Note getting started developing Rust
Note git workflow
Note guide for new contributors
Note operator overloading
Note priority issue criteria
Note research
Note rustc hacking guide back end
Note rustc hacking guide front end
Note rustc hacking guide middle end
Note rustc hacking guide
Note seeing LLVM output from rust
Note style guide
Note tag label names and definitions
Note testsuite
Note wiki conventions
Notes
OS Bridge 2013 tutorial
Operating system development
Projects using Rust
Rustpkg schedule
Sigil reference
Teaching Rust
The Rusticon
Using Rust on Windows
lib template
No results
6
Note wiki conventions
Carter Hinsley edited this page 2015-02-01 19:53:56 +00:00
The GitHub Wiki system is generally good but suffers from a few missing built-in features:
- Categorization
- Tagging
- Namespacing
This makes it tricky to navigate. On the upside, it's written in simple Markdown and can be accessed through git. This makes it very easy to keep manually organized, in the local filesystem.
A couple important points to keep in mind when editing and, particularly, naming pages:
- Please use Markdown, not one of the many other markup languages GitHub provides.
- Let the filename be the title. Do not put any initial headers in pages, as GitHub will (in some places) use that as the title rather than the filename. The filename is what you make internal wiki-links to (with dashes turned into spaces). Just use that name.
- We manually maintain a category list in the file
_Sidebar.md, which turns into the sidebar on all pages. - Prefix every non-navigation page name with a category name. Crude, but it works. So when you make a developer note about foo, call it
Note-foo.md. If it makes you uncomfortable, squint a bit and imagine the category name as a directory name.
All Categories:
- Docs -- For users
- Notes -- For developers
- Libs -- For library authors
- Meeting minutes