Skip to content

Conversation

@0xTim
Copy link
Member

@0xTim 0xTim commented Jan 31, 2023

Adds the getting started guide for Vapor

open Package.swift
```

Vapor's template contains a number of files and functions already set up for you. **configure.swift** contains the code to configure your application and **routes.swift** contains route handler code.
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe a bit nitpicky, but filenames I'd expect in `` code blocks, not "bold"

Copy link
Member Author

Choose a reason for hiding this comment

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

This is a habit I've picked up from Kodeco 😅 Essentially, filenames are code so they shouldn't be code blocks, but we use bold to highlight them. Happy to change though, I don't think we have any guidance either way

Copy link
Contributor

@ktoso ktoso left a comment

Choose a reason for hiding this comment

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

Looks good to me :)


```swift
// 1
app.get("json", ":name") { req async throws -> UserResponse in
Copy link
Contributor

Choose a reason for hiding this comment

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

nit request instead of req more aligned with api guidelines?

Copy link
Member Author

Choose a reason for hiding this comment

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

Easy either way, all the Vapor docs and examples use req


```bash
cd HelloVapor
open Package.swift
Copy link
Contributor

Choose a reason for hiding this comment

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

xed . also works

@0xTim 0xTim merged commit 7235c28 into content-improvements Feb 5, 2023
@0xTim 0xTim deleted the vapor-guide branch February 5, 2023 23:43
kaishin added a commit that referenced this pull request Sep 7, 2023
* 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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants