Skip to main content

Contribute third-party docs

PUBLIC PREVIEW DOCUMENT

This document is currently in public preview and may change significantly as feedback is captured from readers like you. Click the Request an update button at the top of this document or join the Arbitrum Discord to share your feedback.

Third-party docs are documents that help readers of Arbitrum docs use other products, services, and protocols (like the ones listed in the Arbitrum portal) with Arbitrum products.

These documents are usually authored by partner teams, but can be authored by anyone. They follow the same general process that core docs follow, in addition to the following guidelines:

  1. Eligibility
    • Third-party docs are intended to support products listed in the Arbitrum portal, or infrastructure and services that those products use.
    • To submit your project to the Arbitrum portal, apply using this Google form.
  2. Purpose
    • The purpose of our Third-party docs sections is to meet Arbitrum developer (or user) demand for guidance that helps them use non-Arbitrum products with Arbitrum products.
    • It's not meant to drive traffic to your product (although that may happen); it's meant to solve problems that our readers are actually facing, which are directly related to Arbitrum products.
  3. Maintenance expectations
    • Offchain Labs can't commit to maintaining third-party docs, but we make it easy for you to maintain them.
    • Ensure that your document's YAML frontmatter contains a third_party_content_owner property, with the Github username of the designated maintainer. This person will be assigned to your document's issues and PRs, and will be expected to resolve them in a timely manner.
  4. Organization
    • Third-party docs are organized within the Third-party content node located at the bottom of each documentation section's sidebar.
    • This node's content is grouped by third-party product. If/when this becomes unwieldy, we'll begin grouping products by portal category.
  5. Limited document types
    • To manage our team's limited capacity, third-party documents must be either Quickstarts, How-tos, or Concepts. See document types.
  6. Incremental contributions: One document at a time, procedures first
    • Third-party document PRs should contain at most one new document.
    • Any given product's first docs contribution should be a Quickstart or How-to.
    • Additional documents will be merged only if we can verify that our readers are deriving value from your initial contribution.
    • The way that we verify this isn't yet formally established, and it isn't publicly disclosed. Our current approach combines a number of objective and subjective measures.
  7. Policy acknowledgment
    • Before merging third-party documentation PRs, we ask contributors to acknowledge that they've read, understood, and agree with the following policies:
      1. Content ownership: As the author, you retain ownership of and responsibility for the content you contribute. You're free to use your content in any way you see fit outside of Arbitrum's docs. Remember that when contributing content to our documentation, you must ensure you have the necessary rights to do so, and that the content doesn't infringe on the intellectual property rights of others.
      2. License for use: By contributing your content to our documentation, you grant Offchain Labs a non-exclusive, royalty-free license to use, reproduce, adapt, translate, distribute, and display the content in our documentation. This allows us to integrate your content into our docs and make it available to all users.
      3. Right to modify or remove: Offchain Labs reserves the right to modify or remove third-party content from our documentation at any time. This might be necessary due to a range of reasons, such as content becoming outdated, receiving very low pageviews over an extended period, or misalignment with our guidelines or goals.