Skip to content

Commit

Permalink
Make the apidoc accessible from main site
Browse files Browse the repository at this point in the history
  • Loading branch information
reidspencer committed Aug 15, 2024
1 parent 941403a commit c6874df
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 9 deletions.
17 changes: 8 additions & 9 deletions doc/src/main/hugo/content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ creatordisplayname: "Reid Spencer"
creatoremail: "[email protected]"
---

<img src="/images/RIDDL-Logo.svg" align="left" width="100px"/>IDDL is a
<img src="/static/images/RIDDL-Logo.svg" align="left" width="100px"/>IDDL is a
language and toolset for specifying a system design. RIDDL is *not*
a programming language. This documentation is structured to accommodate
many learning styles. It is not intended to be read linearly. This page
Expand All @@ -23,6 +23,13 @@ as it answers many fundamental questions about RIDDL, defining what RIDDL
is, what it can do, what it is based upon, who helped it come to fruition, and
how to get help.

## Quick Help

* This Documentation: https://riddl.tech/
* Scala 3 API DOC: https://riddl.tech/apidoc/
* GitHub Source Code: https://github.com/ossuminc/riddl/
* Examples Repository: https://github.com/ossuminc/riddl-examples/

## Guides
People involved with RIDDL come from many professional roles so there are
[Guides]({{< relref "./guides" >}}) that provide learning paths for those
Expand Down Expand Up @@ -58,14 +65,6 @@ use them.
If you're interested in knowing how we plan to extend RIDDl in the future,
please review our [Future Work]({{< relref "./future-work" >}}) section.

## Important Links

* This Documentation: https://riddl.tech/
* Scala 3 API DOC: https://riddl.tech/apidoc/
* Source Code: https://github.com/ossuminc/riddl/
* Examples Repository: https://github.com/ossuminc/riddl-examples/
* Contact: [Reid's LinkedIn Profile](https://www.linkedin.com/in/reidspencer/)

## Full Index

{{< toc-tree >}}
Binary file added doc/src/main/hugo/static/images/github.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit c6874df

Please sign in to comment.