Compare commits

..

3 Commits

Author SHA1 Message Date
Alexis Bridoux 694028dee6 Getting started tutorial 2023-06-18 12:53:15 +02:00
Alexis Bridoux b315769c5f
Merge pull request #272 from ABridoux/master
Master to develop
2022-03-21 08:58:22 +01:00
Alexis Bridoux 0d57d24883
Merge pull request #271 from ABridoux/master
Master to develop
2022-03-20 16:12:41 +01:00
3 changed files with 29 additions and 0 deletions

View File

@ -16,6 +16,7 @@ Supported formats:
- <doc:new-4.0.0>
### Essential
- <doc:getting-started-tuto>
- <doc:getting-started>
- ``PathExplorer``
- ``Path``

View File

@ -0,0 +1,17 @@
@Tutorial(time: 10) {
@Intro(title: "Data navigation") {
Learn how to navigate through data using ``Scout/PathExplorers``.
}
@Section(title: "Create a PathExplorer") {
@ContentAndMedia {
The simplest way to read data in any of the supported format is to use one of the ``Scout/PathExplorers`` implementation and to call ``Scout/SerializablePathExplorer/init(data:)``.
}
@Steps {
@Step {
For instance, lets imagine that the file is read and converted to a Data value. Heres how to make an explorer for the YAML format.
}
}
}
}

View File

@ -0,0 +1,11 @@
@Tutorials(name: "Scout") {
@Intro(title: "Getting started") {
Quickly learn how to use Scouts main features.
}
@Chapter(name: "Materials") {
Have a look at the data you are going to work with.
@TutorialReference(tutorial: "doc:data-navigation")
}
}