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

Update readme to latest template syntax #2178

Merged
merged 10 commits into from
Dec 20, 2023
Merged

Update readme to latest template syntax #2178

merged 10 commits into from
Dec 20, 2023

Conversation

tpmccallum
Copy link
Contributor

Signed-off-by: tpmccallum [email protected]

This readme is also visible from https://crates.io/crates/spin-sdk

Signed-off-by: tpmccallum [email protected]

This readme is also visible from https://crates.io/crates/spin-sdk

Signed-off-by: Timothy McCallum <[email protected]>
sdk/rust/README.md Outdated Show resolved Hide resolved
sdk/rust/README.md Show resolved Hide resolved
Signed-off-by: tpmccallum [email protected]

Signed-off-by: Timothy McCallum <[email protected]>
Signed-off-by: tpmccallum [email protected]

Signed-off-by: Timothy McCallum <[email protected]>
sdk/rust/README.md Outdated Show resolved Hide resolved
Signed-off-by: tpmccallum [email protected]

Signed-off-by: Timothy McCallum <[email protected]>
sdk/rust/README.md Outdated Show resolved Hide resolved
sdk/rust/README.md Outdated Show resolved Hide resolved

```rust
use anyhow::Result;
Copy link
Collaborator

Choose a reason for hiding this comment

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

We don't import anyhow::Result in the example above so I would remove this and change line 45 to:

async fn handle_hello_world(_req: Request) -> anyhow::Result<impl IntoResponse> {

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done!

sdk/rust/README.md Show resolved Hide resolved
tpmccallum and others added 2 commits December 18, 2023 11:24
Signed-off-by: tpmccallum [email protected]

Co-authored-by: Ryan Levick <[email protected]>
Signed-off-by: Timothy McCallum <[email protected]>
Signed-off-by: tpmccallum [email protected]

Co-authored-by: Ryan Levick <[email protected]>
Signed-off-by: Timothy McCallum <[email protected]>
sdk/rust/README.md Outdated Show resolved Hide resolved
Signed-off-by: tpmccallum [email protected]

Signed-off-by: Timothy McCallum <[email protected]>
Copy link
Contributor Author

@tpmccallum tpmccallum left a comment

Choose a reason for hiding this comment

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

Hi @rylev
Agreed, the README file is limited in what it explains to the user.
I have added a section that links to the developer documentation.

Signed-off-by: tpmccallum [email protected]

Signed-off-by: Timothy McCallum <[email protected]>
@rylev
Copy link
Collaborator

rylev commented Dec 18, 2023

@tpmccallum I don't see the section linking to the developer docs. Where can I find that?

Signed-off-by: tpmccallum [email protected]

Signed-off-by: Timothy McCallum <[email protected]>
@tpmccallum
Copy link
Contributor Author

Oh, my apologies @rylev (and good catch). It seems the backticks stopped the text from being an inline commit (and my changes were just added as general comments).
Screenshot 2023-12-20 at 08 48 50
This is probably a blessing in disguise because it made me rethink where that paragraph should go for impact. I have placed the links to the developer documentation at the top of the file. Please approve if you like this approach so we can merge. Also, I am not sure how to make sure that these new changes are rendered on crates.io page (from memory, sometimes a new version bump and commit/merge to the crate is required, i.e. 0.0.N)

Copy link
Collaborator

@rylev rylev left a comment

Choose a reason for hiding this comment

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

Left one comment with something we should address but other than that looks great!

sdk/rust/README.md Show resolved Hide resolved
Signed-off-by: tpmccallum [email protected]

Signed-off-by: Timothy McCallum <[email protected]>
@tpmccallum
Copy link
Contributor Author

Thanks so much for the review @rylev ; greatly appreciated!!!

@tpmccallum tpmccallum merged commit c87a5b6 into main Dec 20, 2023
11 checks passed
@rylev rylev deleted the tpmccallum-patch-1 branch December 22, 2023 09:34
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.

2 participants