Skip to content
This repository has been archived by the owner on Jan 1, 2025. It is now read-only.

Feedback on readme (fns installation) #34

Open
pandeyanujk opened this issue Mar 25, 2023 · 1 comment
Open

Feedback on readme (fns installation) #34

pandeyanujk opened this issue Mar 25, 2023 · 1 comment

Comments

@pandeyanujk
Copy link

@rekpero I am responding to the request on the Filecoin EVM slack channel. Below are a few things to consider -

  • Profiles section - you have used enum for the coinType & have a specific set of tokens supported. I think it may be useful to explicitly mention what's supported today & what's coming soon (a good chance to showcase the roadmap).
  • Clarifying content fetch w/ an example would be nice to add given the current use case is tied to registering an FNS or searching for one. I am assuming the content may be of type = image?
  • Internal structure section is good. It would be nice to add a diagram somewhere showcasing either the architecture or an entity relationship diagram. A sequence diagram may be a good option too.

These are all optional things. The documentation is good as is. Perhaps add some images/emojis to make it fun to read :)

@rekpero
Copy link
Contributor

rekpero commented Mar 26, 2023

Thank @pandeyanujk, for the suggestions on our doc. We will start working on it.

@arome3 arome3 mentioned this issue Mar 27, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants