Introducing : ARK Docs — Articles, Guides, and Technical Documentation Gathered in One Place

in #blockchain3 years ago

Over the course of the last few weeks, the ARK crew + the amazing ARK community have been working on ARK documentation that spans the entirety of the ARK ecosystem. Everyone here at ARK is happy to announce the debut version of ARK Docs. We look forward to the hearing your input as we continue to improve and expand our documentation and technical guidance.

A great deal of work has gone into the re-write of our codebase for ARK Core v2. The development team has been hard at work for months writing brand new features and solidifying ARK as an industry leader in blockchain technology. While they were hard at work coding, the rest of the team set their sites on ensuring that the systems surrounding the ARK Core are of the same quality you have come to expect from our team.

With ARK Core v2, we identified Documentation as a key area to focus our efforts. Developers are a key piece of the ARK Ecosystem and providing proper, organized documentation was one of our top priorities. We feel that starting a new chapter in ARK’s history (ARK Core) needs to have proper documentation readily available, all in one place and not spread throughout different sites, links, repositories, etc.

As such, we are happy to announce ARK Docs.

ARK Docs is available at :

ARK Docs is a collaborative effort between the ARK crew and ARK community members that covers articles focused on the blockchain industry, the ARK network, ARK Guides, FAQs, the new plugin system and most importantly properly covering APIs starting with v1 and v2. This will give developers easy access to documentation for tools they need to start building on top of the ARK network.

Let’s go over the website so you’ll be able to get a grasp on how things are parcelled together.

ARK docs is segmented into 4 main subcategories:

  1. Documentation — this will open a list of different topics/articles/guides. It covers different blockchain topics and ARK in general. Reading this through should give you a sense on what a blockchain is, how ARK works, how to use it and even show you how to setup your own ARK node or your ARK-based chain in a matter of minutes.

  2. API — this will open API documentation that is categorized into a few subcategories:
     — API 1.0: list of all available API calls, along with detailed information and examples for current version of the ARK network.
     — API 2.0: list of all available API calls, along with detailed information and examples for the upcoming ARK Core network.
    — JSON-RPC: is a remote procedure call protocol encoded in JSON. It is a very simple protocol and a list of all available JSON-RPC calls are available for ARK.
    — Webhooks: list of all available Webhook calls, along with detailed information and examples for the upcoming ARK Core network.
     — SDKs: will cover a variety of different implementations for different programming languages and how to make proper calls and implementations.

  3. FAQ — Frequently Asked Questions covers answers to questions that get asked most of the times via email, in our Slack channels and on other social media channels — feel free to make a suggestion if you think something is not covered.

  4. Community Discussions — there is an option for community discussions and support on ARK docs, so if you have any specific questions, need development guidance or anything ARK related, you can ask it inside ARK Docs. Over time, this will also help to fill in the knowledge-base and provide further information to specific technical questions all gathered under one roof.

There is also an additional sections on the homepage of ARK Docs on the right side:

  • Search : you can search for specific keywords and the readme will query through documentation to present you with closest findings so finding something specific can take a matter of seconds.

Help Us Improve Our “Ark Library”

When a user opens an article in the documentation, a button will be available on the right side labeled “SUGGEST EDITS”. Click on the button and write your improvements or corrections. After you are done, click on the button “Submit Suggested Edits” for a review by the ARK team.

ARK is a community focused project and is highly motivated by collaboration. In keeping with that theme, EVERYONE has an option to suggest edits. If you think something can be further improved or if you have found a mistake, don’t hesitate to let us know.

As this is the debut version of ARK Docs, many of the articles are still being written or may be pending review. In the mean time, we would love to get your initial feedback, ideas on what we might have missed, and what we can improve to make ARK Docs the central home for all of our documentation. Please share your thoughts with us on Slack, Reddit and ARK Docs discussions. We want to hear from you!

Follow us on social media ( Twitter | Facebook | Reddit ) and stay tuned to our blog on Medium and here on Steemit.