diff --git a/docs/00-welcome.mdx b/docs/00-welcome.mdx new file mode 100644 index 0000000..b27aa61 --- /dev/null +++ b/docs/00-welcome.mdx @@ -0,0 +1,67 @@ +--- +id: welcome +title: Welcome +--- + +# Welcome to the DANDI Archive Documentation + + +![dandi banner](/img/dandi-banner.png) + +The Web interface to the DANDI archive is located at [https://dandiarchive.org](https://dandiarchive.org). +This documentation explains how to interact with the archive. + +## How to Use This Documentation + +If you want to know more about the DANDI project, its goals, and the problems +it tries to solve, check out the [Introduction](./00-welcome.mdx). + +To start using the archive, head over to [Using DANDI](./00-welcome.mdx) in the User Guide section. + +If you are a developer and want to know how the project is organized, check out the [Project Structure](./00-welcome.mdx) +page in the Developer Guide section. + +## Where to Get Help + +You can communicate with the DANDI team in a variety of ways, depending on your needs: + +- You can ask questions, report bugs, or + request features [at our helpdesk](https://github.com/dandi/helpdesk/issues/new/choose). +- For interacting with the global neuroscience community, post on [Neurostars](https://neurostars.org) + and use the tag [dandi](https://neurostars.org/tag/dandi). +- You can use the DANDI Slack workspace, which we will invite you to after approving your [registration on + DANDI using GitHub](https://dandiarchive.org/) (this registration is required to upload data or to use the DANDI + JupyterHub). See [here for details on how to + register](./00-welcome.mdx). +- Email us: [info@dandiarchive.org](mailto:info@dandiarchive.org) + +## Contributing and Feedback + +We are looking for people to give us feedback on this documentation. If anything +is unclear, [open an issue on our repository](https://github.com/dandi/handbook/issues). You can also get in touch on +our Slack channel, which is available to those who have +registered an account on the archive. + +If you want to get started right away and contribute directly to this +documentation, see the [About This Documentation](./00-welcome.mdx) section. + +## License + +<a + rel="license" + href="http://creativecommons.org/licenses/by/4.0/" +> + <img + alt="Creative Commons License" + style={{ borderWidth: 0 }} + src="https://i.creativecommons.org/l/by/4.0/88x31.png" + /> +</a> +<br /> +This work is licensed under a +<a + rel="license" + href="http://creativecommons.org/licenses/by/4.0/" +> + Creative Commons Attribution 4.0 International License +</a> diff --git a/docs/intro.md b/docs/intro.md deleted file mode 100644 index 5b74dcc..0000000 --- a/docs/intro.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Tutorial Intro - -Let's discover **Docusaurus in less than 5 minutes**. diff --git a/docusaurus.config.ts b/docusaurus.config.ts index ac3373b..a4ed745 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -67,7 +67,7 @@ const config: Config = { // Replace with your project's social card image: 'img/docusaurus-social-card.jpg', navbar: { - title: 'My Site', + title: 'DANDI', logo: { alt: 'My Site Logo', src: 'img/logo.svg', @@ -96,8 +96,8 @@ const config: Config = { title: 'Docs', items: [ { - label: 'Tutorial', - to: '/docs/intro', + label: 'Documentation', + to: '/docs/welcome', }, ], }, diff --git a/src/pages/index.tsx b/src/pages/index.tsx index 400a3e1..63e1f3d 100644 --- a/src/pages/index.tsx +++ b/src/pages/index.tsx @@ -8,7 +8,7 @@ import Heading from '@theme/Heading'; import styles from './index.module.css'; function HomepageHeader() { - const {siteConfig} = useDocusaurusContext(); + const { siteConfig } = useDocusaurusContext(); return ( <header className={clsx('hero hero--primary', styles.heroBanner)}> <div className="container"> @@ -19,8 +19,8 @@ function HomepageHeader() { <div className={styles.buttons}> <Link className="button button--secondary button--lg" - to="/docs/intro"> - Docusaurus Tutorial - 5min ⏱️ + to="/docs/welcome"> + DANDI Introduction </Link> </div> </div> @@ -29,7 +29,7 @@ function HomepageHeader() { } export default function Home(): JSX.Element { - const {siteConfig} = useDocusaurusContext(); + const { siteConfig } = useDocusaurusContext(); return ( <Layout title={`Hello from ${siteConfig.title}`} diff --git a/static/img/dandi-banner.png b/static/img/dandi-banner.png new file mode 100644 index 0000000..c9d270f Binary files /dev/null and b/static/img/dandi-banner.png differ