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

[UXIT-1706] Enhance Clarity and Consistency in ‘What is Filecoin’ Section #2330

Merged
merged 13 commits into from
Nov 7, 2024

Conversation

mirhamasala
Copy link
Collaborator

@mirhamasala mirhamasala commented Oct 25, 2024

This PR improves readability and consistency in multiple sections of the Filecoin documentation, including updates to language flow, terminology alignment, and clearer explanations in key areas such as the storage model, retrieval market, blockchain, crypto-economics, networks, and programming on Filecoin.

@mirhamasala mirhamasala changed the title [DRAFT] Edit "What is Filecoin" Enhance Clarity and Consistency in ‘What is Filecoin’ Section Nov 4, 2024
@mirhamasala mirhamasala marked this pull request as ready for review November 4, 2024 16:09
@mirhamasala mirhamasala requested a review from smagdali November 4, 2024 16:09
@mirhamasala mirhamasala changed the title Enhance Clarity and Consistency in ‘What is Filecoin’ Section [UXIT-1706] Enhance Clarity and Consistency in ‘What is Filecoin’ Section Nov 4, 2024
Copy link
Member

@smagdali smagdali left a comment

Choose a reason for hiding this comment

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

This is great. I'm definitely not a fan of American-style 'Capitalising All Headings No Matter What' though, and that's not what we do elsewhere on the site?

Huh, the readme.md on github used to have a style guide in it, I guess Johnny deleted it when we moved to Gitbook.

* Verified Registry Actor - responsible for managing verified clients.
* Ethereum address Manager (EAM) Actor- responsible for assigning all Ethereum compatible addresses on Filecoin Network, including EVM smart contract addresses and Ethereum account addresses.
* EVM Account Actor - a non-singleton built-in actor representing an external Ethereum identity backed by a secp256k1 key.
- **System Actor**: General system actor.
Copy link
Member

Choose a reason for hiding this comment

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

These should all be normal case. "Init actor" - they are not proper nouns (and yes, this is the only one that was correct before)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Okay - done.

@@ -12,7 +12,7 @@ description: >-

## FILFOX

[https://calibration.filfox.info/en](https://calibration.filfox.info/en)
[https://calibration.filfox.info/en](http://47.109.105.51/en)
Copy link
Member

Choose a reason for hiding this comment

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

this situation is temporary - I'm trying to figure out what's going on with them but we should probably list both for now.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

It doesn't pass the link checker test if the link is broken and thus the PR can't be merged.. We can revert is once they fix it?

@mirhamasala
Copy link
Collaborator Author

mirhamasala commented Nov 7, 2024

@smagdali - I quite like the visual hierarchy that capitalising heading provides. And was planning for us to implement it throughout the docs. Following your comment, I reverted it.

This is great. I'm definitely not a fan of American-style 'Capitalising All Headings No Matter What' though, and that's not what we do elsewhere on the site?

Huh, the readme.md on github used to have a style guide in it, I guess Johnny deleted it when we moved to Gitbook.

Yes, a style guide would be helpful.

~ Requested changes have been implemented but the link checker is not happy - I don't have enough information to know what to do about those.

@mirhamasala mirhamasala force-pushed the mm/copy-edits branch 2 times, most recently from 8d0f0f7 to d3f7c2b Compare November 7, 2024 06:40
@smagdali smagdali merged commit a2cbabb into main Nov 7, 2024
2 of 3 checks passed
@smagdali smagdali deleted the mm/copy-edits branch November 7, 2024 06:56
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