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

Improve tutorial.md to reference freenet-email app directly #1049

Open
sanity opened this issue Apr 17, 2024 · 0 comments
Open

Improve tutorial.md to reference freenet-email app directly #1049

sanity opened this issue Apr 17, 2024 · 0 comments
Labels
A-documentation Area: Improvements or additions to documentation

Comments

@sanity
Copy link
Collaborator

sanity commented Apr 17, 2024

Currently the examples in the tutorial leave out parts of the code:

struct Posts(...)

impl Posts {
  fn add_post(&mut self, post: Post) { ... }
}

struct Post(...)

The tutorial should instead reference a working example, most likely the freenet-email-app. mdbook has useful functionality for including portions of files from elsewhere in the repo. Using this will ensure that the documentation stays in sync with the code.

@sanity sanity added the A-documentation Area: Improvements or additions to documentation label Apr 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documentation Area: Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant