Skip to content
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

docs: 0.4.x readability improvements #188

Merged
merged 1 commit into from
Sep 18, 2022

Conversation

ryanrussell
Copy link
Contributor

Signed-off-by: Ryan Russell git@ryanrussell.org

Here's the updates for the docs/0.4.x ... submitting next separately to make it a little easier in case something needs fixed.

-r

@ryanrussell
Copy link
Contributor Author

Heads up on this one, I had not pulled main before I updated this(on the next PR, I saw my main was ~30 commits behind first).

If anything needs a force push, let me know :)

@@ -4,7 +4,7 @@ As you may have noticed while using Perseus, compiling even very small changes t

The first step in addressing this is to figure out whether your app needs exporting or not. If not, then you should use `#[perseus::main_export]` rather than `#[perseus::main(...)]` in your `lib.rs`, and then you don't need to bring in a server integration, which should speed things up slightly. Notably, if you choose not to do this, there's no actual compile-time difference between `perseus export` and `perseus serve` (there used to be, back in the days of `.perseus/`, but those horrors are gone now). As a general rule, apps that *can* go to static files *should* go to static files, because they'll be faster. (It's also more easily possible to push static files to edge networks in deployment, which usually means faster load times for your users, depending on your hosting provider.)
Copy link
Contributor

Choose a reason for hiding this comment

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

Shouldn't that be main.rs rather than lib.rs?

Signed-off-by: Ryan Russell <git@ryanrussell.org>
Copy link
Member

@arctic-hen7 arctic-hen7 left a comment

Choose a reason for hiding this comment

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

Looks great, thank you very much!

@arctic-hen7 arctic-hen7 merged commit e385e21 into framesurge:main Sep 18, 2022
@ryanrussell ryanrussell deleted the 0.4.x-readability-fixes branch September 18, 2022 10:50
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.

None yet

3 participants