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 and Fix Links in Example README.md Files #3017

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

cypherpepe
Copy link

Motivation

Several README.md files across different example projects contained broken or outdated links. Ensuring that all documentation links are functional and up-to-date is essential for providing users with reliable resources for setting up and using these projects. This improves the overall user experience and reduces confusion caused by inaccessible or incorrect references.

Proposal

This PR addresses the issue by updating and fixing broken links in the README.md files of the following example projects:

  • crowd-funding
  • fungible
  • hex-game
  • social/web-frontend

Changes include:

  • Replacing non-working URLs with active and relevant links.
  • Correcting typos to enhance clarity and professionalism in the documentation.

Release Plan

  • Nothing to do / These changes follow the usual release cycle.

    These updates pertain solely to documentation and do not require a special release process. They will be included in the next standard release cycle.

Signed-off-by: Cypher Pepe <[email protected]>
Signed-off-by: Cypher Pepe <[email protected]>
Signed-off-by: Cypher Pepe <[email protected]>
Signed-off-by: Cypher Pepe <[email protected]>
@ma2bd
Copy link
Contributor

ma2bd commented Dec 7, 2024

@cypherpepe Good catch. Thanks! So technically these README files are generated from the lib.rs files using cargo rdme.

Signed-off-by: Cypher Pepe <[email protected]>
Signed-off-by: Cypher Pepe <[email protected]>
Signed-off-by: Cypher Pepe <[email protected]>
@cypherpepe
Copy link
Author

@ma2bd Done

@@ -30,7 +30,7 @@ Tokens can be transferred from an account to different destinations, such as:
## Setting Up

The WebAssembly binaries for the bytecode can be built and published using [steps from the
book](https://linera-io.github.io/linera-documentation/getting_started/first_app.html),
book](https://linera.dev/developers/getting_started/installation.html),
Copy link
Contributor

Choose a reason for hiding this comment

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

still out of sync with lib.rs

Copy link
Author

Choose a reason for hiding this comment

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

done

Signed-off-by: Cypher Pepe <[email protected]>
@cypherpepe cypherpepe requested a review from ma2bd December 16, 2024 17:25
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