Skip to content

Update README - #1154

Merged
0xTim merged 25 commits into
vapor:mainfrom
swifty-amay:my-doc-update
Jul 24, 2026
Merged

Update README#1154
0xTim merged 25 commits into
vapor:mainfrom
swifty-amay:my-doc-update

Conversation

@swifty-amay

Copy link
Copy Markdown
Contributor

A separate PR for the README file.

swifty-amay and others added 7 commits July 22, 2026 23:04
Co-authored-by: Paul Toffoloni <69189821+ptoffy@users.noreply.github.com>
Co-authored-by: Paul Toffoloni <69189821+ptoffy@users.noreply.github.com>
Co-authored-by: Paul Toffoloni <69189821+ptoffy@users.noreply.github.com>
Co-authored-by: Paul Toffoloni <69189821+ptoffy@users.noreply.github.com>
Co-authored-by: Paul Toffoloni <69189821+ptoffy@users.noreply.github.com>
Co-authored-by: Paul Toffoloni <69189821+ptoffy@users.noreply.github.com>
Co-authored-by: Paul Toffoloni <69189821+ptoffy@users.noreply.github.com>
@swifty-amay

swifty-amay commented Jul 22, 2026

Copy link
Copy Markdown
Contributor Author

This is in reference to the change requested in README stated as
"You shouldn't need Python anymore, we've migrated to Kiln. But let's update this bit in a separate PR so if you could remove this section, that would be great (keep the typo though!)"

But using 'swift run' is only generating and giving a static ./site folder, so if python3 is not there then who will serve the folder?

Kiln is only being used for building the folder named ./site as stated in ref. to line 37 in
' docs/Sources/VaporDocs/main'

               ' try await Kiln.build(site, contentDirectory: "docs", outputDirectory: outputDirectory, linkChecking: .error,    
                leafTags: VaporDesignTheme.leafTags) '

So what should I do now?

image

@fpseverino

Copy link
Copy Markdown
Member

who will serve the folder?

I think we should tell people to use the Kiln CLI, right @0xTim?

@swifty-amay

Copy link
Copy Markdown
Contributor Author

Ya you're right
the 'swift run kiln serve' command is working fine
Let me just update it.

Thanks for sharing the info @fpseverino

Updated prerequisites and instructions for running the project.
Comment thread README.md Outdated
Comment thread README.md Outdated
Amay Raj Srivastav and others added 3 commits July 24, 2026 08:56

@0xTim 0xTim left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks!

@0xTim
0xTim enabled auto-merge (squash) July 24, 2026 10:46
@0xTim
0xTim merged commit 4d1f55e into vapor:main Jul 24, 2026
1 check passed
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.

3 participants