The NEAR Wiki was proposed and established in this thread:
The goal of the NEAR Wiki is:
To establish a single source of information on all aspects of the NEAR Ecosystem for NEAR Users, Developers, and Community Members (Guild, Validator, etc.).
Currently, the NEAR Wiki is live, community-driven, and built using GitBook.
The purpose of this post is to propose a development plan and roadmap for the NEAR Wiki throughout the remainder of Q4 2021 and into early Q1 2022.
After completion of the plan outlined below the NEAR Wiki will be a fully fleshed-out source of information with relevant information siloed into user personas (Guilds, Users, Developers, Community Members).
The information should be easy to access, understand, and expand on.
Ultimately, we’ll be looking to leverage the knowledge of the NEAR Community in order to achieve this goal.
The timeline of this plan is from the date of the publication of this document to the end of Q4 2021 and into early Q1 2022.
ETA: W/C 22nd Nov
Currently, the NEAR Wiki is built using GitBook.
This was discussed in the original forum proposal and recommended by @illia here:
However, GitBook recently underwent an update which has resulted in a myriad of issues including missing and removed Wiki pages. The reasoning behind this was kindly illustrated by @jwaugh:
For anyone interested, the problem is that merged pull requests are not reflected in changes to the live wiki, so you have to disconnect and resync with GitHub to get such edits. Only direct commits are pulled into GitBook.
In response to this, James has already begun the process of Docusaurus migration:
I created a new branch in the wiki repo, set up Docusaurus, and pasted content from the other branch.
You can see a rough draft here: https://near.github.io/wiki
Alternatively, we might use the “Wiki” feature on GitHub to align with our Ecosystem Map initiative (sending contributors to the same place):
The direction of this plan is open to change, nothing written here is final. I encourage any and all feedback!
Here are a few points in favour of migrating to Docusaurus:
Our documentation repository will be aligned with the current technical documentation hosted on Docusaurus.
There exist technical issues with the Github x GitBook connections which result in regular manual work
Polkadot has done an incredible job with their Wiki by leveraging Docusaurus. We can emulate this without making a direct copy.
It’s free (not a huge priority, but always a plus).
ETA: W/C 22nd Nov
Initially, and partly due to the urgency of the NEAR Wiki v1, we will base the user personas on assumptions rather than any validated user research.
Personas will form the basis of the categories for the Wiki as a whole, similar to how Polkadot has executed it with categories.
Newly Proposed Personas:
Previously there existed six personas; Developer, Validator, Guild, End-User, Investor, and Founder. I propose a reduction of these to 4 personas:
General information regarding NEAR, an introduction to the protocol, and ‘how-to’ guides. We’d like to include the ecosystem roadmap that the Ecosystem Success team is currently developing.
Content surrounding Guilds, including, but not limited to, how to join, how to connect, and how to create a Guild.
Tech-focused content will likely include the docs and developer resources.
Validator documentation, core protocol information.
The number of personas is kept intentionally low to provide a better user experience when users attempt to find the information they’re looking for.
ETA: W/C 22nd Nov - 17th December
We’ll be actively pursuing Community (and team) contributions to the NEAR Wiki.
The NEAR Portal Guild was set up by @blaze in order to produce informative content for the NEAR Ecosystem. Through incentivization, we’ll be leveraging the NEAR Portal Guild in order to produce the required content for the NEAR Wiki.
A lot of content already exists, however it’s distributed through documentation on different websites and internal documents (in some cases).
To keep in line with the simple nature of NEAR tech, and the core tenets of decentralization, we’ll collate and publish all relevant documentation in the NEAR Wiki directly.
This phase will not be restricted to content creation but will include, quite heavily, ideation for relevant content, too.
After migrating to Docusaurus we’ll be sharing a guide on how to contribute - this includes the contribution process and a writing style guide.
If you’d like to join the NEAR Portal Guild and begin contributing to the NEAR Wiki then feel free to do so here:
Feel free to respond to this thread with any questions or proposals for information which should be included in the NEAR Wiki.
ETA: 20th - 31st Dec
As essential and valuable as community-driven contributions are, it’s important to be conscious of the fact that the official NEAR Wiki is representing NEAR in many ways.
Consequently, after documentation is published every effort will be made to review and refine the contributions. This is focused on the content’s grammar, accuracy, and writing style.
A style guide will be developed and published to assist contributors ASAP.
ETA: Completion by 14th January, 2022
As with many things in the NEAR Ecosystem, there will never be a point where the NEAR Wiki is ‘complete’. As the ecosystem continues to evolve, so will the NEAR Wiki.
I propose we semi-regularly (TBD) request feedback and assessment from the Community and Wiki users. This could be rolled up into another type of user feedback initiative we take.
Could we implement a feedback feature directly into the Wiki page itself?
This is something that Docusaurus can support but it requires a certain amount of tech attention. If we don’t have this internally, we can outsource this.
A part of the Docusaurus rollout would include the implementation of a feedback widget, similar to the one shown below:
The goal of this is to measure whether the information in the Wiki articles is satisfying the needs of the reader. Further to this, we’d seek to implement more granular feedback methods, including a text box, in order to understand what information seekers are trying to find and failing to do so.
As outlined in Phase 4, we’ll rely on the NEAR Community and, primarily, Wiki users to gather and synthesise feedback.
I’d encourage you all to please leave feedback in this thread. We really want to nail the NEAR Wiki and we can only do so with your help.