As you are aware, we have been working on a standalone Dev Website for the community with the aim of launching it by SAFE DevCon on 23rd April.
Time and time again the community forums show developers enjoy being able to:
Quickly access information that is relevant to their preferred language/platform
Get questions answered fast (typically these are split by language and whether you are new to the SAFE Network technology)
See the latest changes/news easily
The existing SAFE Network documentation can be confusing, is out of date in some cases and spread across many platforms. Ongoing development is vital for the SAFE Network, so providing great information in an easy to consume way will support our existing community better, and encourage more development on the Network. A standalone developer website will be an important tool in the armoury of any SAFE developer.
Therefore we propose a dev specific website which will:
Consolidate the currently scattered documents (white papers, API documentation, tutorials) and create a one-stop-shop for links, roadmaps, platform information etc
Provide clear pathways for new users to bootstrap
Provide information relevant to the user’s preferred language/platform
Below, we outline the mock designs for this website. We would love to hear your feedback on content, design, layout, usability, any features which would be important for launch, and features you would like for future iterations.
Please put your feedback in the comments section below by Wednesday 4th April, to enable us to have the website ready for DevCon.
Rather than keeping information solely in the Dev Forum, or in GitHub, a standalone website creates a landing page for all things development. Here the ability to guide users through the key aspects of the SAFE Network is possible as well as continuing to provide links to other resources, and of course back to the Dev Forum.
- Clear pathways
Right from the homepage, we take the opportunity to provide education and guidance for new users, while keeping it relevant for seasoned developers. The use of banners can be introduced on the homepage which could be used to advertise network/API features; talk about new updates or events; highlight apps on the SAFE Network etc.
Scrolling down the home page new users are led through the bootstrapping process with each of the four key aspects explained sequentially: Understand, Develop, Test, Deploy. With the Get Started button taking users to the Discover page.
- Preferred programming language/platform
To be able to cater to different languages and platforms we propose three distinct pages - App Devs; Core Devs and Platforms. The overall site structure also reflects this approach:
Note: Options to navigate between App Dev and Core Dev pages are always available from the top of each page. Also, at the top right, a ‘chat’ icon is displayed throughout the website, to ensure quick access to the Dev Forum at all times, enabling community conversations to continue and questions asked at any time.
The App Dev page will include descriptions of the various container types and data types, along with language-specific information:
Users can access their relevant platform/programming language preference via the icons at either the top or bottom of the App Dev page:
Each page outlines installation instructions and examples:
The Core Dev page includes links to each GitHub repository for each of the components, links to RFCs and information about licensing and the various defensive patents in place:
The third and final top-level page is the Discover page. The Discover page walks the user through the main components of the SAFE Network such as the Authenticator, Vaults and the network flavours of local, mock and testnets. Should a user want to deep-dive further, they would navigate to either the App Dev or Core Dev page (as required).
Overall, this website has been designed with the developer front and centre, providing easy access to information that is regularly discussed and accessed via the Dev Forum. Although the intention is not to replace the forum, this website will complement it, providing a one-stop-shop approach to better support our developer community.
We look forward to your feedback and further thoughts on changes and website features to add to our roadmap for the future.