-
-
Notifications
You must be signed in to change notification settings - Fork 78.9k
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 docs "Welcome" section #10528
Add docs "Welcome" section #10528
Conversation
* Fixes unrelated typo in readme * Add new Welcome section with history, team, callouts, and community subsections * Redesigns callouts to be a bit lighterweight with colored headings
<img src="https://2.gravatar.com/avatar/a98244cbdacaf1c0b55499466002f7a8?d=https%3A%2F%2Fidenticons.github.com%2F313701b540df992682dccc8f70dc12a0.png" alt="@fat"> | ||
<strong>Jacob Thornton</strong> <small>@fat</small> | ||
</a> | ||
<a class="list-group-item team-member" href="https://github.com/juthilo"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Erm...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm so sorry, I get a little bit encroaching sometimes. 😱
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hrmmm?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You copied my profile URL into Chris's section. Or were you referring to my weird comment above?
I think this is a great addition, smoothing the edges a little for users coming in directly without knowing about the GitHub project. |
I'd love some copy editing love btw—forgot to include that in the original comment. I rushed through some of this and spent way too much time on the rest. |
<ul> | ||
<li>Read and subscribe to <a href="http://blog.getbootstrap.com/">The Official Bootstrap Blog</a>.</li> | ||
<li>Have a question that's not a feature request or bug report? <a href="http://groups.google.com/group/twitter-bootstrap">Ask on the mailing list.</a></li> | ||
<li>Chat with fellow Bootstrappers in IRC. On the <code>irc.freenode.net</code> server, in the <a href="irc://irc.freenode.net/twitter-bootstrap">##twitter-bootstrap channel</a>.</li> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The "On..." part is an incomplete sentence fragment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be "on IRC" rather than "in IRC".
We should also gloss what the IRC acronym means.
A thought, should this "Welcome" be separate in its own nav item, leaving "Getting Started" as focused, task-centric, and stand-alone? I say this because Also See the downside is "getting started" becomes a scroll-scroll-scroll to the meat of the matter, which begins at the |
<div class="page-header"> | ||
<h1 id="welcome">Welcome!</h1> | ||
</div> | ||
<p class="lead">You're looking at the official documentation for Bootstrap, a front-end framework for building on the Web. Get the background story on Bootstrap, useful tidbits about the docs, helpful community links, and more.</p> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps include the version number in the 1st sentence.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a thought: the second sentence could be interpreted as a description for the whole docs. Perhaps include a 'below' to make clear it's only describing the following section's contents?
I have finished making copyediting suggestions. |
@@ -97,7 +97,7 @@ Editor preferences are available in the [editor config](.editorconfig) for easy | |||
Keep track of development and community news. | |||
|
|||
* Follow [@twbootstrap on Twitter](http://twitter.com/twbootstrap). | |||
* Read and subscribe to the [The Official Bootstrap Blog](http://blog.getbootstrap.com). | |||
* Read and subscribe to [The Official Bootstrap Blog](http://blog.getbootstrap.com). | |||
* Have a question that's not a feature request or bug report? [Ask on the mailing list.](http://groups.google.com/group/twitter-bootstrap) | |||
* Chat with fellow Bootstrappers in IRC. On the `irc.freenode.net` server, in the `##twitter-bootstrap` channel. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Proposal for this line and the adapted one in getting-started,html:
Chat with fellow Bootstrappers using IRC on the
irc.freenode.net
server, in the ##twitter-bootstrap channel.
The link is actually irc://irc.freenode.net/#twitter-bootstrap (including the #), because the channel is "non-primary" and has two ##.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Gah, the double hash in the URL doesn't work for me. Might need to ditch the URL.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Huh? There's one hash in the URL and a double hash in the channel name.
Apart from the IRC stuff, nothing else from me. |
@StevenBlack All good points—appreciate you chiming in.
Seeing welcome and getting started by each other sounds confusing, hence the inclusion in an existing page.
I suppose we could do some of this on a separate page, e.g. "About". I'll noodle on that.
Ohhh, good call. I'll get that started by adding the examples and snippets to the list.
For sure, definitely seeing that. Downloading and using the code is the most important thing, so we need to balance that. Should we include the "docs intro" in the Getting started page or on this extra "About" page? |
<p class="lead">You're looking at the official documentation for Bootstrap (v{{ site.version }}), a front-end framework for building on the Web. Before diving in, get the background story on Bootstrap, useful tidbits about the docs, helpful community links, and more.</p> | ||
|
||
<h2 id="welcome-history">Brief history</h3> | ||
<p>Bootstrap was created at Twitter in mid-2010 by <a href="https://twitter.com/mdo">@mdo</a> and <a href="https://twitter.com/fat">@fat</a>. Prior to being open-sourced framework, Bootstrap was known as Twitter Blueprint. A few months into development, Twitter held its <a href="https://blog.twitter.com/2010/hack-week">first Hack Week</a> and the project exploded. It served as the style guide for internal tools development at the company for over a year before its public release.</p> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Prior to being open-sourced framework" [sic]. Don't need "framework".
Still one HTML validation error (well, 4 instances of the same error):
|
</a> | ||
<a class="list-group-item team-member" href="https://github.com/juthilo"> | ||
<iframe class="github-btn" src="http://ghbtns.com/github-btn.html?user=juthilo&type=follow" width="120" height="20"></iframe> | ||
<img src="http://www.gravatar.com/avatar/bc4ab438f7a4ce1c406aadc688427f2c" alt="@juthilo"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just merged this manually into master as an About page. |
Hi, the commits as of this Pull Request somehow landed on Getting started anyway. :) |
This also broke HTML validation: https://travis-ci.org/twbs/bootstrap/builds/12508229 |
Should all be fixed, thanks fellas. |
Taking a cue from a couple of other projects and a sudden urge to document more than just our framework components, I'm proposing a new docs section. It includes:
/cc @cvrebert @juthilo