docs: Add Core Library to introduction section of the Sway book #6193
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jjcnn
requested changes
Jun 27, 2024
IGI-111
requested changes
Jun 27, 2024
There was a problem hiding this comment.
This entire change is a non starter, you should not manually document the standard library when we've explicitly been building forc doc to do so. What should happen is that the documentation for core is hosted in the same way we host the one for std.
If you feel that core is insufficiently documented, you should add some doc comments directly in there.
All that the book should have is a link to the auto-generated documentation, the same it does for std.
kayagokalp
reviewed
Jun 27, 2024
There was a problem hiding this comment.
I think core is already hosted here. Maybe we may want to improve the doc comments surrounding the stuff from core instead of writing from scratch.
bitzoic
reviewed
Jul 1, 2024
Co-authored-by: IGI-111 <igi-111@protonmail.com>
…Labs/sway into docs/add-core-library-intro
IGI-111
reviewed
Jul 4, 2024
IGI-111
reviewed
Jul 4, 2024
IGI-111
reviewed
Jul 4, 2024
IGI-111
reviewed
Jul 4, 2024
IGI-111
reviewed
Jul 12, 2024
jjcnn
previously approved these changes
Jul 12, 2024
IGI-111
approved these changes
Jul 15, 2024
kayagokalp
approved these changes
Jul 15, 2024
esdrubal
pushed a commit
that referenced
this pull request
Aug 13, 2024
## Description https://fuellabs.slack.com/archives/C031TTYJM60/p1719402172570099 ## Checklist - [ ] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [x] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [ ] I have added tests that prove my fix is effective or that my feature works. - [ ] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. --------- Co-authored-by: IGI-111 <igi-111@protonmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
https://fuellabs.slack.com/archives/C031TTYJM60/p1719402172570099
Checklist
Breaking*orNew Featurelabels where relevant.