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

Navigation & Organisation of the User Documentation #292

Open
nishenmene opened this issue Sep 21, 2024 · 0 comments
Open

Navigation & Organisation of the User Documentation #292

nishenmene opened this issue Sep 21, 2024 · 0 comments

Comments

@nishenmene
Copy link

nishenmene commented Sep 21, 2024

ENS is a great platform that really humanises web3 for many people both in the web3 and especially for those in the web2 space and is a great protocol to simplify the way we interact on the chain!

So it was really great to contribute to this project during the ETH Global Singapore Hackathon.

There were many places for improvement but have to say that, the ENS support documentation is very comprehensive, especially regarding having a lot of technical information about the protocol.

A good amount code is provided as examples but more can be done to make things easier for the user, such as providing more example code in separate appendices that can be expanded. 

I believe it is beneficial to integrate the support documentation for the tools and libraries described in https://docs.ens.domains/web/libraries within the documentation in addition to including the web page. This would provide easy access to the developer when accessing external tooling. 

The documentation describes concepts simply however, the navigation from the left panel could be improved to have the most important elements bundled into logical subgroups in https://docs.ens.domains/dao. This would make the docs cleaner and easier to understand, especially given that most 'proposals' in there such as https://docs.ens.domains/dao/proposals/5.7 don't affect the developers day to day use of the documents and doesn't add to their knowledge of coding for ENS. Thus, they don't need to be prominently individually displayed in the left panel. 

The Governance page can include more information about the DAO and provide in-document information about the technical background behind the governance of ENS.

About Me;

Hey everyone! I am an Oxford University Graduate in MEng Engineering Science with a background in Computing, Software Development and Machine Learning. I enjoy being in the blockchain space as a community developer in the Oxford Blockchain Society ecosystem where I organise events, coding workshops and even hackathons to get students and alumni to get into the blockchain space.

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

No branches or pull requests

1 participant