Skip to content

Commit

Permalink
Moving specification to it's own section
Browse files Browse the repository at this point in the history
This prepares the work of versioning the specification without
versioning the whole website.

It makes it easier to find as this is a very specific (pun not
intended) beat that deserves its own place.
  • Loading branch information
pgrange committed Jun 1, 2023
1 parent ededfc8 commit 22bd8f1
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,7 @@ jobs:
uses: actions/download-artifact@v3
with:
name: hydra-spec
path: docs/static/
path: docs/specification

- name: 📚 Documentation sanity check
if: github.ref_name != 'master' && github.ref_name != 'release'
Expand Down
16 changes: 16 additions & 0 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,17 @@ const config = {
editLocalizedFiles: true,
}),
],
[
"content-docs",
/** @type {import('@docusaurus/plugin-content-docs').Options} */
({
id: "specification",
path: "specification",
routeBasePath: "specification",
editUrl,
editLocalizedFiles: true,
}),
],
[
"content-docs",
/** @type {import('@docusaurus/plugin-content-docs').Options} */
Expand Down Expand Up @@ -168,6 +179,11 @@ const config = {
position: "left",
},
{
to: "/specification",
label: "Specification",
position: "left",
},
{
to: "/benchmarks",
label: "Benchmarks",
position: "left",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ The specification is currently written in LaTeX and can be
[edited](https://github.com/input-output-hk/hydra/tree/master/spec) in the
Hydra repository. A rendered version is shown below or can be downloaded or viewed in fullscreen here: [Download](/hydra-spec.pdf)

import HydraSpecUrl from '@site/static/hydra-spec.pdf';
[comment]: # hydra-spec.pdf must be referenced with relative link to ensure correct versionning

import HydraSpecUrl from './hydra-spec.pdf';

<iframe style={{width: '100%', height: '480px'}} src={HydraSpecUrl} title="Hydra Head Specification"></iframe>

0 comments on commit 22bd8f1

Please sign in to comment.