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: documentation refresh for milestone #644

Merged
merged 22 commits into from
Mar 17, 2023

Conversation

deekerno
Copy link
Contributor

@deekerno deekerno commented Mar 13, 2023

Closes #566, #579.

Changelog

  • Add information about contract IDs and the need to change them after editing contract
  • Add information about optional schema fields
  • Remove bits using --background flag with fuel-indexer run command
  • Fix query example on block explorer example
  • Add link to M1/M2 WASM fix to WASM dependency page
  • Fix keyboard navigation issue (cannot click right after fuelup #579) by adding index pages to problem sections
  • Fix terminology usage in places
  • Add "Queries" page to GraphQL (I felt that it's better to have more information than less)
  • Add Appendix header with Glossary section
  • Edit and correct sentence structure in various places
  • Replaced old Fuel logo in README with a Fuel Indexer header image (thanks @Braqzen!)

Testing Steps

  1. cargo install mdbook
  2. cd docs
  3. mdbook serve
  4. Navigate to localhost:3000 and read the book

@deekerno deekerno added documentation Improvements or additions to documentation work in progress labels Mar 13, 2023
@deekerno deekerno self-assigned this Mar 13, 2023
@deekerno deekerno linked an issue Mar 13, 2023 that may be closed by this pull request
@deekerno deekerno force-pushed the deekerno/566-update-book-for-beta-4 branch 2 times, most recently from 9d8a667 to 081efed Compare March 13, 2023 18:49
@deekerno deekerno marked this pull request as ready for review March 13, 2023 20:11
@deekerno deekerno requested review from ra0x3 and a team March 13, 2023 20:11
Copy link
Contributor

@sarahschwartz sarahschwartz left a comment

Choose a reason for hiding this comment

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

Amazing, thank you! For the receipt type references it would be nice to have small examples for how those can be used in a handler function. For example, in the ReturnData receipt type, we could add something like this:

You can handle functions that produce a ReturnData receipt type by using the returned type as a function parameter like this:

fn handle_return_data(data: MyStruct) {
  // handle the returned data
}

@deekerno
Copy link
Contributor Author

@sarahschwartz, I definitely think that's a beneficial change! If @ra0x3 agrees, then feel free to push up something that you feel works best.

@deekerno deekerno requested a review from 0xmovses March 13, 2023 22:27
@deekerno deekerno force-pushed the deekerno/566-update-book-for-beta-4 branch from 081efed to 354fd37 Compare March 14, 2023 04:12
Copy link
Contributor

@0xmovses 0xmovses left a comment

Choose a reason for hiding this comment

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

Some really great additions to our docs! Particularly glossary.md and graphql/queries.md, I think users will find that very useful. Just a few suggestions.

docs/src/reference-guide/components/assets/manifest.md Outdated Show resolved Hide resolved
docs/src/reference-guide/components/assets/manifest.md Outdated Show resolved Hide resolved
docs/src/glossary.md Outdated Show resolved Hide resolved
docs/src/reference-guide/components/indexers/index.md Outdated Show resolved Hide resolved
@ra0x3 ra0x3 added the blocked This change is currently blocked by a linked issue label Mar 14, 2023
@ra0x3
Copy link
Contributor

ra0x3 commented Mar 14, 2023

blocked by #630

@deekerno deekerno force-pushed the deekerno/566-update-book-for-beta-4 branch from 230d611 to 33026c7 Compare March 16, 2023 15:57
@deekerno deekerno removed the blocked This change is currently blocked by a linked issue label Mar 16, 2023
@deekerno deekerno force-pushed the deekerno/566-update-book-for-beta-4 branch from 33026c7 to 2a385ea Compare March 16, 2023 17:50
@deekerno deekerno force-pushed the deekerno/566-update-book-for-beta-4 branch 4 times, most recently from 7d6ce3e to 62a34e7 Compare March 17, 2023 17:28
@deekerno deekerno force-pushed the deekerno/566-update-book-for-beta-4 branch from 62a34e7 to 4d9caba Compare March 17, 2023 17:29
@deekerno deekerno merged commit d6e9c3f into master Mar 17, 2023
@deekerno deekerno deleted the deekerno/566-update-book-for-beta-4 branch March 17, 2023 19:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

cannot click right after fuelup Update documentation for beta-4 milestone
4 participants