diff --git a/doc/_index.md b/doc/_index.md deleted file mode 100644 index daab8da108347..0000000000000 --- a/doc/_index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "Documentation" ---- - -{{% sectionContent %}} diff --git a/doc/project/contributing.md b/doc/contributing/README.md similarity index 100% rename from doc/project/contributing.md rename to doc/contributing/README.md diff --git a/doc/ug/bazel_notes.md b/doc/contributing/bazel_notes.md similarity index 100% rename from doc/ug/bazel_notes.md rename to doc/contributing/bazel_notes.md diff --git a/doc/rm/continuous_integration/index.md b/doc/contributing/ci/README.md similarity index 100% rename from doc/rm/continuous_integration/index.md rename to doc/contributing/ci/README.md diff --git a/doc/rm/continuous_integration/continuous_integration_overview.svg b/doc/contributing/ci/continuous_integration_overview.svg similarity index 100% rename from doc/rm/continuous_integration/continuous_integration_overview.svg rename to doc/contributing/ci/continuous_integration_overview.svg diff --git a/doc/project/detailed_contribution_guide/_index.md b/doc/contributing/detailed_contribution_guide/README.md similarity index 100% rename from doc/project/detailed_contribution_guide/_index.md rename to doc/contributing/detailed_contribution_guide/README.md diff --git a/doc/project/detailed_contribution_guide/contributing_code_flow_chart.svg b/doc/contributing/detailed_contribution_guide/contributing_code_flow_chart.svg similarity index 100% rename from doc/project/detailed_contribution_guide/contributing_code_flow_chart.svg rename to doc/contributing/detailed_contribution_guide/contributing_code_flow_chart.svg diff --git a/doc/ug/directory_structure.md b/doc/contributing/directory_structure.md similarity index 100% rename from doc/ug/directory_structure.md rename to doc/contributing/directory_structure.md diff --git a/doc/ug/dv_methodology/index.md b/doc/contributing/dv/methodology/README.md similarity index 100% rename from doc/ug/dv_methodology/index.md rename to doc/contributing/dv/methodology/README.md diff --git a/doc/ug/dv_methodology/dv_method_multi_gate.svg b/doc/contributing/dv/methodology/dv_method_multi_gate.svg similarity index 100% rename from doc/ug/dv_methodology/dv_method_multi_gate.svg rename to doc/contributing/dv/methodology/dv_method_multi_gate.svg diff --git a/doc/ug/dv_methodology/dv_method_single_gate.svg b/doc/contributing/dv/methodology/dv_method_single_gate.svg similarity index 100% rename from doc/ug/dv_methodology/dv_method_single_gate.svg rename to doc/contributing/dv/methodology/dv_method_single_gate.svg diff --git a/doc/ug/sec_cm_dv_framework/index.md b/doc/contributing/dv/sec_cm_dv_framework/README.md similarity index 100% rename from doc/ug/sec_cm_dv_framework/index.md rename to doc/contributing/dv/sec_cm_dv_framework/README.md diff --git a/doc/ug/sec_cm_dv_framework/diagram_of_block_that_contains_sec_cm_primitive.svg b/doc/contributing/dv/sec_cm_dv_framework/diagram_of_block_that_contains_sec_cm_primitive.svg similarity index 100% rename from doc/ug/sec_cm_dv_framework/diagram_of_block_that_contains_sec_cm_primitive.svg rename to doc/contributing/dv/sec_cm_dv_framework/diagram_of_block_that_contains_sec_cm_primitive.svg diff --git a/doc/ug/sec_cm_dv_framework/diagram_of_sec_cm_prim.svg b/doc/contributing/dv/sec_cm_dv_framework/diagram_of_sec_cm_prim.svg similarity index 100% rename from doc/ug/sec_cm_dv_framework/diagram_of_sec_cm_prim.svg rename to doc/contributing/dv/sec_cm_dv_framework/diagram_of_sec_cm_prim.svg diff --git a/doc/ug/fpga_boards.md b/doc/contributing/fpga/get_a_board.md similarity index 100% rename from doc/ug/fpga_boards.md rename to doc/contributing/fpga/get_a_board.md diff --git a/doc/rm/ref_manual_fpga.md b/doc/contributing/fpga/ref_manual_fpga.md similarity index 100% rename from doc/rm/ref_manual_fpga.md rename to doc/contributing/fpga/ref_manual_fpga.md diff --git a/doc/ug/github_notes.md b/doc/contributing/github_notes.md similarity index 100% rename from doc/ug/github_notes.md rename to doc/contributing/github_notes.md diff --git a/doc/rm/comportability_specification/index.md b/doc/contributing/hw/comportability/README.md similarity index 100% rename from doc/rm/comportability_specification/index.md rename to doc/contributing/hw/comportability/README.md diff --git a/doc/rm/comportability_specification/comportability_diagram_intr_hw.svg b/doc/contributing/hw/comportability/comportability_diagram_intr_hw.svg similarity index 100% rename from doc/rm/comportability_specification/comportability_diagram_intr_hw.svg rename to doc/contributing/hw/comportability/comportability_diagram_intr_hw.svg diff --git a/doc/rm/comportability_specification/comportability_diagram_peripheral.svg b/doc/contributing/hw/comportability/comportability_diagram_peripheral.svg similarity index 100% rename from doc/rm/comportability_specification/comportability_diagram_peripheral.svg rename to doc/contributing/hw/comportability/comportability_diagram_peripheral.svg diff --git a/doc/ug/hw_design.md b/doc/contributing/hw/design.md similarity index 100% rename from doc/ug/hw_design.md rename to doc/contributing/hw/design.md diff --git a/doc/ug/design.md b/doc/contributing/hw/methodology.md similarity index 100% rename from doc/ug/design.md rename to doc/contributing/hw/methodology.md diff --git a/doc/ug/vendor_hw.md b/doc/contributing/hw/vendor.md similarity index 100% rename from doc/ug/vendor_hw.md rename to doc/contributing/hw/vendor.md diff --git a/doc/sg/_index.md b/doc/contributing/style_guides/README.md similarity index 100% rename from doc/sg/_index.md rename to doc/contributing/style_guides/README.md diff --git a/doc/sg/asm_coding_style.md b/doc/contributing/style_guides/asm_coding_style.md similarity index 100% rename from doc/sg/asm_coding_style.md rename to doc/contributing/style_guides/asm_coding_style.md diff --git a/doc/sg/c_cpp_coding_style.md b/doc/contributing/style_guides/c_cpp_coding_style.md similarity index 100% rename from doc/sg/c_cpp_coding_style.md rename to doc/contributing/style_guides/c_cpp_coding_style.md diff --git a/doc/sg/guidance_for_volatile.md b/doc/contributing/style_guides/guidance_for_volatile.md similarity index 100% rename from doc/sg/guidance_for_volatile.md rename to doc/contributing/style_guides/guidance_for_volatile.md diff --git a/doc/sg/hjson_usage_style.md b/doc/contributing/style_guides/hjson_usage_style.md similarity index 100% rename from doc/sg/hjson_usage_style.md rename to doc/contributing/style_guides/hjson_usage_style.md diff --git a/doc/sg/markdown_usage_style.md b/doc/contributing/style_guides/markdown_usage_style.md similarity index 100% rename from doc/sg/markdown_usage_style.md rename to doc/contributing/style_guides/markdown_usage_style.md diff --git a/doc/sg/otbn_style_guide.md b/doc/contributing/style_guides/otbn_style_guide.md similarity index 100% rename from doc/sg/otbn_style_guide.md rename to doc/contributing/style_guides/otbn_style_guide.md diff --git a/doc/sg/python_coding_style.md b/doc/contributing/style_guides/python_coding_style.md similarity index 100% rename from doc/sg/python_coding_style.md rename to doc/contributing/style_guides/python_coding_style.md diff --git a/doc/rm/device_interface_functions.md b/doc/contributing/sw/device_interface_functions.md similarity index 100% rename from doc/rm/device_interface_functions.md rename to doc/contributing/sw/device_interface_functions.md diff --git a/doc/ug/otbn_sw.md b/doc/contributing/sw/otbn_sw.md similarity index 100% rename from doc/ug/otbn_sw.md rename to doc/contributing/sw/otbn_sw.md diff --git a/doc/ug/system_list.md b/doc/contributing/system_list.md similarity index 100% rename from doc/ug/system_list.md rename to doc/contributing/system_list.md diff --git a/doc/getting_started/_index.md b/doc/guides/getting_started/src/README.md similarity index 100% rename from doc/getting_started/_index.md rename to doc/guides/getting_started/src/README.md diff --git a/doc/ug/documentation.md b/doc/guides/getting_started/src/build_docs.md similarity index 100% rename from doc/ug/documentation.md rename to doc/guides/getting_started/src/build_docs.md diff --git a/doc/getting_started/build_sw.md b/doc/guides/getting_started/src/build_sw.md similarity index 100% rename from doc/getting_started/build_sw.md rename to doc/guides/getting_started/src/build_sw.md diff --git a/doc/getting_started/getting_started_workflow.svg b/doc/guides/getting_started/src/getting_started_workflow.svg similarity index 100% rename from doc/getting_started/getting_started_workflow.svg rename to doc/guides/getting_started/src/getting_started_workflow.svg diff --git a/doc/getting_started/install_openocd.md b/doc/guides/getting_started/src/install_openocd.md similarity index 100% rename from doc/getting_started/install_openocd.md rename to doc/guides/getting_started/src/install_openocd.md diff --git a/doc/getting_started/install_vivado/index.md b/doc/guides/getting_started/src/install_vivado/README.md similarity index 100% rename from doc/getting_started/install_vivado/index.md rename to doc/guides/getting_started/src/install_vivado/README.md diff --git a/doc/getting_started/install_vivado/features.png b/doc/guides/getting_started/src/install_vivado/features.png similarity index 100% rename from doc/getting_started/install_vivado/features.png rename to doc/guides/getting_started/src/install_vivado/features.png diff --git a/doc/getting_started/setup_dv.md b/doc/guides/getting_started/src/setup_dv.md similarity index 100% rename from doc/getting_started/setup_dv.md rename to doc/guides/getting_started/src/setup_dv.md diff --git a/doc/getting_started/setup_formal.md b/doc/guides/getting_started/src/setup_formal.md similarity index 100% rename from doc/getting_started/setup_formal.md rename to doc/guides/getting_started/src/setup_formal.md diff --git a/doc/getting_started/setup_fpga.md b/doc/guides/getting_started/src/setup_fpga.md similarity index 100% rename from doc/getting_started/setup_fpga.md rename to doc/guides/getting_started/src/setup_fpga.md diff --git a/doc/getting_started/setup_verilator.md b/doc/guides/getting_started/src/setup_verilator.md similarity index 100% rename from doc/getting_started/setup_verilator.md rename to doc/guides/getting_started/src/setup_verilator.md diff --git a/doc/project/hw_checklist.md.tpl b/doc/project/hw_checklist.md.tpl deleted file mode 120000 index b6b34158e5f59..0000000000000 --- a/doc/project/hw_checklist.md.tpl +++ /dev/null @@ -1 +0,0 @@ -../../util/uvmdvgen/checklist.md.tpl \ No newline at end of file diff --git a/doc/project/_index.md b/doc/project_governance/README.md similarity index 100% rename from doc/project/_index.md rename to doc/project_governance/README.md diff --git a/doc/project/checklist.md b/doc/project_governance/checklist/README.md similarity index 100% rename from doc/project/checklist.md rename to doc/project_governance/checklist/README.md diff --git a/doc/project_governance/checklist/hw_checklist.md.tpl b/doc/project_governance/checklist/hw_checklist.md.tpl new file mode 120000 index 0000000000000..1d5eee0be3b0b --- /dev/null +++ b/doc/project_governance/checklist/hw_checklist.md.tpl @@ -0,0 +1 @@ +../../../util/uvmdvgen/checklist.md.tpl \ No newline at end of file diff --git a/doc/project/sw_checklist.md.tpl b/doc/project_governance/checklist/sw_checklist.md.tpl similarity index 100% rename from doc/project/sw_checklist.md.tpl rename to doc/project_governance/checklist/sw_checklist.md.tpl diff --git a/doc/project/committers.md b/doc/project_governance/committers.md similarity index 100% rename from doc/project/committers.md rename to doc/project_governance/committers.md diff --git a/doc/project/development_stages.md b/doc/project_governance/development_stages.md similarity index 100% rename from doc/project/development_stages.md rename to doc/project_governance/development_stages.md diff --git a/doc/project/priority_definitions.md b/doc/project_governance/priority_definitions.md similarity index 100% rename from doc/project/priority_definitions.md rename to doc/project_governance/priority_definitions.md diff --git a/doc/project/rfc_process.md b/doc/project_governance/rfc_process.md similarity index 100% rename from doc/project/rfc_process.md rename to doc/project_governance/rfc_process.md diff --git a/doc/project/technical_committee.md b/doc/project_governance/technical_committee.md similarity index 100% rename from doc/project/technical_committee.md rename to doc/project_governance/technical_committee.md diff --git a/doc/ug/rust_for_c.md b/doc/rust_for_c_devs.md similarity index 100% rename from doc/ug/rust_for_c.md rename to doc/rust_for_c_devs.md diff --git a/doc/ug/_index.md b/doc/ug/_index.md deleted file mode 100644 index cfffe770d4cd3..0000000000000 --- a/doc/ug/_index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "User Guides" ---- - -{{% sectionContent %}}