diff --git a/src/config/sidebar.yml b/src/config/sidebar.yml index 261284df5c7c43669943a6e42b39141154927ae5..7c843749ddbcace9762d83d6ea4833bf66046c4f 100644 --- a/src/config/sidebar.yml +++ b/src/config/sidebar.yml @@ -16,8 +16,8 @@ # link: '/getting-started/environment' - label: Tutorials items: - - label: 'Part 0: Overview' - link: '/part1/overview' + - label: 'Overview' + link: '/overview' - label: 'Part 1: Simple Detectors' link: '/part1/simple_detector' - label: 'Part 2: Adding Detectors' @@ -32,13 +32,13 @@ link: 'https://dd4hep.web.cern.ch/dd4hep/reference/classdd4hep_1_1Detector.html' - label: 'Links' link: '/links' -- label: Usage - items: - - label: 'doc Getting started' - link: '/gettingstartedold' - - label: 'Creating docs' - link: '/usage/creating-docs' - - label: 'Navigation' - link: '/usage/navigation' - - label: 'Shadowing' - link: '/usage/shadowing' + #- label: Usage + # items: + # - label: 'doc Getting started' + # link: '/gettingstartedold' + # - label: 'Creating docs' + # link: '/usage/creating-docs' + # - label: 'Navigation' + # link: '/usage/navigation' + # - label: 'Shadowing' + # link: '/usage/shadowing' diff --git a/src/docs/overview.md b/src/docs/overview.md new file mode 100644 index 0000000000000000000000000000000000000000..5a33a1c3993280ccc712839702f701664cb94d77 --- /dev/null +++ b/src/docs/overview.md @@ -0,0 +1,22 @@ +--- +title: "Overview" +--- + + +## Data model + + +## PODIO + +- Eicweb fork: https://eicweb.phy.anl.gov/EIC/podio +- AIDAsoft repo: https://github.com/AIDASoft/podio + +## LCIO2 + +[Defined in yaml +file](https://eicweb.phy.anl.gov/EIC/podio/blob/master/lcio2/lcio-edm.yaml) +which is used to generate C++ library. + + + + diff --git a/src/docs/gettingstartedold.mdx b/src/docs/usage/gettingstartedold.mdx similarity index 100% rename from src/docs/gettingstartedold.mdx rename to src/docs/usage/gettingstartedold.mdx diff --git a/src/docs/usage/introduction.mdx b/src/docs/usage/introduction.mdx new file mode 100644 index 0000000000000000000000000000000000000000..0a36db1f6865603d3a23ebcb7e78675a9efe98f7 --- /dev/null +++ b/src/docs/usage/introduction.mdx @@ -0,0 +1,60 @@ +--- +title: "Introduction" +metaTitle: "This is the title tag of this page" +metaDescription: "This is the meta description" +--- + +# Tutorial + +- [Quick start](quickstart.md) +Start here to setup download software and configure your development environment. +- [Part 1](part1.md) +An introduction to detecto description starting with a simple detector. This tutorial shows how to add new parameterized detectors to a library of generic detectors (NPdet). +- [Part 2](part2.md) + +This tutorial is broken in to multiple parts. + +* Preface for the new programmer +* Part 0a: Configuring your running environment +* Part 0b: Configuring your development environment +* Part 1: Simple Detector Example +* Part 2: Extending Detector Geometry +* Part 3: Adding a new detector +* Part 4: Detector digitization, volumes, and segmentation +* Part 5: Event reconstruction + + +Some introduction text. Lists out all the headings from h1 to h6. Easy to customise. Some more text. Additional text. + +# Heading H1 +Heading 1 text + +## Heading H2 +Heading 2 text + +### Heading H3 +Heading 3 text + +#### Heading H4 +Heading 4 text + +##### Heading H5 +Heading 5 text + +###### Heading H6 +Heading 6 text + + + +# Welcome +This tutorial is meant to prepare you to contribute to the simuliation toolkit for the EIC. +The tutorial is not meant to be a representation of the final software workflow, but to put enough pieces +together to do the work required. + + +## Lists +- Item 1 +- Item 2 +- Item 3 +- Item 4 +- Item 5