Skip to content

Commit 326134d

Browse files
authored
Merge pull request #71 from SpineEventEngine/update-structure
Update project folder structure
2 parents 182859b + 0d3ad9d commit 326134d

35 files changed

Lines changed: 59 additions & 92 deletions

docs/_preview/config/_default/hugo.toml

Lines changed: 0 additions & 52 deletions
This file was deleted.

docs/_preview/hugo.toml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
baseURL = 'https://spine.io/'
2+
languageCode = 'en-us'
3+
title = 'Documentation preview'
4+
disableKinds = ['taxonomy', 'term']
5+
6+
[module]
7+
# First theme has higher priority than later ones.
8+
[[module.imports]]
9+
path = '../..'
10+
[[module.imports]]
11+
path = 'github.com/SpineEventEngine/site-commons'
12+
13+
# Enables HTML rendering in markdown files.
14+
[markup]
15+
[markup.goldmark]
16+
[markup.goldmark.renderer]
17+
unsafe = true
18+
[markup.goldmark.parser]
19+
[markup.goldmark.parser.attribute]
20+
block = true
21+
title = true
22+
[markup.highlight]
23+
noClasses = false

docs/content/docs/1/_index.md

Lines changed: 0 additions & 37 deletions
This file was deleted.

docs/content/docs/_index.md

Lines changed: 35 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,37 @@
11
---
2-
build:
3-
render: never
2+
title: Documentation
3+
headline: Documentation
44
---
5+
6+
# Welcome
7+
8+
{{% note-block class="lead" %}}
9+
Welcome to the Spine developer documentation. This page gives
10+
the overview of the documentation sections.
11+
{{% /note-block %}}
12+
13+
## [Quick Start](docs/quick-start/)
14+
In this section you can learn what it's like to develop with Spine by going
15+
through the code of the [Hello World]({{% get-site-data "repositories.examples" %}}/hello/)
16+
example.
17+
18+
## [Introduction](docs/introduction/)
19+
This section gives an overview of the development process, the architecture of
20+
the Spine-based application, information on DDD concepts implemented by the
21+
framework and how framework users deal with them.
22+
23+
## [Guides](docs/guides/validation)
24+
This section provides detailed instructions on the framework use.
25+
26+
## [Client Libraries](docs/client-libs/)
27+
This section provides language-specific guides for building client-side applications.
28+
29+
## [API Reference](docs/reference/)
30+
This sections provides links to the generated documentation.
31+
32+
## [Examples](docs/examples/)
33+
This page is the entry point for learning from the code of
34+
the [example applications]({{% get-site-data "repositories.examples" %}}).
35+
36+
## [DDD Resources](docs/resources/)
37+
A brief selection of learning materials we recommend to the colleagues in DDD.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)