Hi Team,
I hope this message finds you well.
I’ve spent some time reviewing our current documentation, specifically:
Frankly, the current state of our documentation gives an impression of an old or abandoned blockchain. This is a significant concern, as our documentation is often the first touchpoint for new developers and users.
To get a sense of what top-tier documentation looks like, I explored the documentation of some of our competitors:
- Polygon Documentation
- BNB Chain Documentation
- Avalanche Documentation
- Arbitrum Documentation
- Solana Documentation
These platforms showcase up-to-date information, an easy-to-explore interface, and valuable resources that enhance user experience.
To be in the top 1, we must start taking care of the basics. Updating our documentation to match or exceed these standards is a critical step.
Let’s discuss and plan the necessary updates to make our documentation not only current but also highly user-friendly and informative.
Best regards.
Discussion (11)
This was one of the topics earlier this year.
We agreed to have only docs.xdc.community as the main documentation website and shutting down the others due to 1st. the maintaining 3 at the same time is heavy-lifting. 2nd. as described on the article "the first touchpoint for new developers and users".
Still I'd see more enhancements/upgrades should be done on this website.
I completely agree with this. There is no point in having multiple documentation pages like there is no point in having multiple explorers with almost similar interface. Maintaining multiple explorer consumes time and money. @blocksscanio team has made some really good and really impressive updates to their explorer. All we need is to focus on a single top notch explorer instead of diverting our energy on maintaining multiple explorers.
Etherscan.io integration with XDC is almost completed. They are indexing all the blockchain data. We will use xdcscan.com domain as the new explorer.
Now, that's really a fantastic news! Great work!
Totally agree. We should remove the other ones, and just use one.
I think maybe community and team can help having an updated Docs.
We can do a bounty system to improve all of that.
Hello Team,
We’re excited to share that we’ve updated several key sections of the XDC Network documentation, including the "Home," "XDC Subnet," "Announcements," and "Showcases" pages. Specifically, under the "Showcases" section, we’ve added the following new topics:
Showcases (docs.xdc.network/showcase/)
Additionally, we’ve completed updates to the "XDC Chain" section as well:
XDC Chain (docs.xdc.network/xdcchain/)
We are committed to making the developer journey smoother and establishing the highest documentation standards in the Web3 space.
To continue improving, we plan to open our documentation GitHub repository for contributions starting next week. If you’re interested in contributing, please share your GitHub username and the specific documentation section where you’d like to contribute, to avoid duplication of effort.
Your feedback is invaluable, so please feel free to share your thoughts on these updates.
Link to the updated documentation: docs.xdc.network/
Thank you for your ongoing support!
CC @Vrushali_26 @omkar_mestry
Lets get one really top of the notch documentation. BTW, I dont know if people behind docs.xdc.community are even active anymore.
The documentation is a part of discussion during every weekly developer's call. Not saying that it's perfect but @anilchinchawale, @lance, @0xbeny, @s4njk4n and many others have been constantly contributing and updating the content on the documentation page. But UI, I believe can definitely be worked upon for a better aesthetics and an even better user experience.
Def.. There are a few community members who are working on enhancements. it's on our track.
Let's connect to identify and improve the documentation to be as helpful as possible for developers.
Let's connect to identify and improve the documentation to be as helpful as possible for developers. Clear and comprehensive documentation is essential for enhancing developer productivity and reducing onboarding time. For more insights, consider looking into the latest updates on hackmd.io/@lakhminews/HJ0n0ipv0 Ofer Baazov.