Update documentation sections#778
Open
olgahryniuk wants to merge 8 commits intoinput-output-hk:mainfrom
Open
Conversation
This PR updates the 'Strategy' section in line with Kris's suggestions. The goal is to ensure that the copy is up-to-date and follows IO's style guidelines. More changes to be made within this PR.
This commit updates FAQs for relevance and the latest development progress. Based on suggestions from Kris.
Updating glossary entries in line with Kris's suggestions
- Add formal specs to resources since we'll remove them from the navigation - Some formatting and editing
This commit updates the use cases section, improving grammar and making the language more appropriate for documentation.
- Improve grammar - Make language more appropriate for documentation
Add the technical design document and fix a broken link
Contributor
Author
|
Hi @ch1bo! This PR is ready for your review and merging.
Thank you! |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR updates the 'Strategy', 'FAQs', and 'Glossary' sections in line with Kris's suggestions. The goal is to ensure the copy is up to date and follows IO's style guidelines.
More sections, including use cases, cost estimates, and resources, are now reviewed and edited as well.