submit-a-repo.md

How To Submit A Repo

• add metadata to your markdown doc file
• create a pr to add your markdown file id to the sidebars config file and add your repo as git submodule under docs folder
• add a ci config to trigger the build workflow of this repo in your repo's ci config

Add Metadata To Your Markdown File

You need to add metadata use syntax below at the beginning of your markdown file. You only need to add metadata to those files that you want to publish to develoepr site.

The custom_edit_url is the github url for editing text files. https://github.com/Conflux-Chain/{repo_name}/edit/{branch_name}/{path_to_md}

---
id: quick_start
title: Quick Start
custom_edit_url: https://github.com/Conflux-Chain/conflux-portal-docs/edit/master/01_Examples/00_Low_Level_CFX_Transfer.md
hide_title: false
hide_table_of_contents: false
sidebar_label: Markdown :)
custom_edit_url: https://github.com/facebook/docusaurus/edit/master/docs/api-doc-markdown.md
description: How do I find you when I cannot solve this problem
keywords:
  - docs
  - docusaurus
image: https://i.imgur.com/mErPwqL.png
---

You can find the documentation and spec for each metadata here.

The id, title and custom_edit_url is required.

Create A PR To Add Your Documentation

Add Your Repo To docs

Use git submodule add https://<your-repo-url>.git docs/<your-repo-folder-name> to add your repo under docs.

Add Your Markdown File To sidebar.js

A sidebar.js is like the below one. Each markdown can be added as { type: "doc", folder: "conflux-portal", id: "quick_start" }. id is the id in markdown metadata, folder is the git submodule folder in docs folder, type is doc.

You create your own document structure with category.

module.exports = {
  docs: {
    en: [
      {
        type: "category",
        label: "Learn About Conflux",
        items: [
          { type: "doc", id: "conflux_overview", folder: "introduction" },
          { type: "doc", id: "core_concepts", folder: "introduction" },
          {
            type: "category",
            label: "Concepts",
            items: [{ type: "doc", id: "treegraph", folder: "introduction" }]
          }
        ]
      },
      {
        type: "category",
        label: "Try Conflux",
        items: [
          { type: "doc", folder: "introduction", id: "try_conflux_core" },
          {
            type: "doc",
            folder: "introduction",
            id: "make_your_first_transaction"
          }
        ]
      },
      {
        type: "category",
        label: "Try Conflux Portal",
        items: [{ type: "doc", folder: "conflux-portal", id: "quick_start" }]
      }
    ]
  }
};

Add A CI Config To Trigger The Build Workflow of This Repo

Once your create your PR, we'll check your repo and submit a PR to add the CI config.

Why It Works

The CI config in your repo will trigger the build workflow of this repo.

The workflow will pull your repo down, check if any doc files being updated between old submodule revision and your master branch, use docusaurus build the doc and update developer.confluxnetwork.org.