improve description of use cases and getting started guides #304
Conversation
tomerd
requested review from
0xTim,
alexandersandberg,
daveverwer,
dempseyatgithub,
kaishin,
krstnfx,
mschinis,
shahmishal,
TimTr and
twostraws
as code owners
|
need help with CSS here since now that we have 3 use cases on the landing page the "boxed" dont quite line up, so either we need a 4th one or we need to fix the CSS so they are on the same line |
motivation: address feedback frmo core-team changes: * improve description of landing page use cases * improve description of getting started guides * add "cross platform command-line tool" as a landing page use case * change link of use cases to their relevant getting started guides
tomerd
force-pushed
the
core-team-followup-01
branch
from
6b2df77 to
036a15d
Compare
|
Happy to help with the CSS. I'm not sure having them all on the same line works so well with the longer descriptions: 
Here are some alternatives: 
I think (2) works quite well. It gives more real estate to "Server and Networking", but it's visually more balanced in regards to the descriptions compared to (1). |
index.md
Outdated
| <a href="/getting-started/swiftui" class="cta-secondary">Learn more</a> | ||
| </li> | ||
| <li> | ||
| <h3>Command-line</h3> | ||
| <p> | ||
| Writing Swift code is interactive and fun, the syntax is concise yet expressive. | ||
| <br><br> | ||
| SwiftArgumentParser and Swift's growing package ecosystem make developing cross-platform command-line tools a breeze. | ||
| </p> | ||
|
|
||
| <a href="https://developer.apple.com/swift/resources/" class="cta-secondary">Learn more</a> | ||
| <a href="/getting-started/cli-swiftpm" class="cta-secondary">Learn more</a> | ||
| </li> | ||
| <li> | ||
| <h3>Server</h3> | ||
| <h3>Server and Networking</h3> | ||
| <p> | ||
| Ever dreamed of using the same programming language on both your mobile applications and their server back-ends? Swift's small footprint, quick startup time, and deterministic performance make it specifically suitable for Server applications. | ||
| Swift code is safe by design and produces software that runs lightning-fast. | ||
| Swift's small memory footprint, quick startup time, and deterministic performance make it a great choice for server and other networked applications. | ||
| <br><br> | ||
| SwiftNIO and Swift's dynamic server ecosystem bring joy to developing networked applications. | ||
| </p> | ||
|
|
||
| <a href="/server" class="cta-secondary">Learn more</a> | ||
| <a href="/getting-started/vapor-web-server" class="cta-secondary">Learn more</a> |
There was a problem hiding this comment.
I'm not sure I would link out to the getting started guides here. The use cases on the landing page are meant to give visitors an overview of how Swift can be used for each case, and, IMO, e.g. https://www.swift.org/server/ does a better job with that than the getting started guide. Not sure about the developer.apple.com link though.
(It might be a bit confusing that we're calling this section "Use Cases", and also having a _use-cases.md file for the getting started page which is meant for the guides, not "Use cases of Swift". Maybe we can rename the getting started section/file.)
There was a problem hiding this comment.
yes, I debated this before making the change. one challange is consistency, ie where should we link the new "command-line tool" use case? we had the same issues with the "apple platforms" link and ended up linking to developer.apple.com
There was a problem hiding this comment.
I agree. We might need some new content for this actually.
|
thanks @alexandersandberg - I like option 2 the most |
This is now introduced in 50b7fba. |
tomerd
force-pushed
the
core-team-followup-01
branch
from
c6bdbd2 to
d15abbd
Compare
* Update landing page content (#127) * First pass at the new Getting Started page (#174) * Adding Getting Started tutorial for SwiftUI / iOS 16. (#185) * Add data file with items for "Go Further" section (#184) * Add cli and library getting started guides (#192) * Getting started tweaks (#208) * Rename Markdown files to have an `.md` extension. (#209) * Fix typo (#214) * Update getting started page layout (#204) * Add documentation information to Getting Started (#226) * Add Vapor Getting Started guide (#229) * Update content-improvments branch per feedback (#244) * Tweak SwiftUI tutorial (#240) * Add TSPL Go Further section and resource thumbnails (#227) * Improve 'Why Swift?' section on landing page (#252) * Replace Go Further item for advanced String Under The Hood blog post with item for Structures and Classes chapter in TSPL (#254) * Update landing page layout (#267) * Link to developer.apple.com from apple use case (#291) * Smaller landing page changes on content improvements branch (#294) * Update Go Further section (#300) * Update icons and placeholder image (#301) * Improve description of use cases and getting started guides (#304) * POC: Feature random code snippet on landing page (#303) * New “Swift is…” and About page copy (#336) * Move link to A Swift Tour to the Use Cases section (#329) * Add consistent download section to start and end of each guide (#351) * Add a new install page, update the download page, and move release yml files into one file. (#310) * Update navigation for install page (#355) * Update cli and library getting started guides (#357) * Content improvement guide updates (#373) * Add value and reference types article (#377) * Add some showcase snippets (#371) * Resolve issue with Red Hat download links (#379) * Add Info about Scoop for Windows install page (#382) --------- Co-authored-by: Alexander Sandberg <[email protected]> Co-authored-by: Paul Hudson <[email protected]> Co-authored-by: James Dempsey <[email protected]> Co-authored-by: tomer doron <[email protected]> Co-authored-by: Dave Verwer <[email protected]> Co-authored-by: Tim Condon <[email protected]> Co-authored-by: Max Desiatov <[email protected]> Co-authored-by: Mishal Shah <[email protected]> Co-authored-by: AG <[email protected]> Co-authored-by: Ted Kremenek <[email protected]>
motivation: address feedback frmo core-team
changes: