Skip to content

Commit b0fd8c8

Browse files
committed
Fix typs and wording in scala3documentation
1 parent 9402c5b commit b0fd8c8

File tree

4 files changed

+13
-11
lines changed

4 files changed

+13
-11
lines changed

docs/docs/usage/scala3doc/blog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ title: Build-in blog
44

55
# {{page.title}}
66

7-
Scala3doc is capable to include blogposts. For now we support only simple blogposts but in future we plan to include more advanced features like tags.
7+
Scala3doc is able to include a simple blog in your documentation. For now it provides only basic features in future we plan to include more advanced features like tagging or author pages.

docs/docs/usage/scala3doc/index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@ title: Scala3doc
44

55
![Scala3doc logo](/images/scala3doc-logo.png)
66

7-
Scala3doc is a doctool dedicated to work with Scala 3.0. Beside basic features similar to `javadoc` or `scaladoc`. As you probably guessed, this
8-
whole site was created using scala3doc.
7+
Scala3doc is tool to generate documentation for your Scala 3 projects. It provies similar features to `javadoc` or `scaladoc` as well as `jekyll` or `docusaurus`.
8+
9+
As you probably guessed, this whole site was created using scala3doc.
10+
911

1012
{% for post in site.posts %}
1113
## [{{ post.title }}](/{{ post.url }})
@@ -20,5 +22,5 @@ whole site was created using scala3doc.
2022

2123
We would love to have your feedback on what you think would be good in order to
2224
render the documentation you want! Perhaps you would like to render method
23-
definitions or members? Let us know by filing
25+
definitions or members? Do you want to have runnable code samples? Let us know by filing
2426
[issues](https://github.com/lampepfl/dotty/issues/new)!

docs/docs/usage/scala3doc/specificTags.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Dottydoc Specific Tags and Behavior
44

55
# {{page.title}}
66

7-
Scala3doc extemds markdown with some unique behaviours such as linking to API. This can be used from within static documentation and blogpost to provide blend-in content.
7+
Scala3doc extends markdown with some unique behaviors such as linking to API. This can be used from within static documentation and blog posts to provide blend-in content.
88

99
## Linking to API
1010

docs/docs/usage/scala3doc/staticSite.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ title: Static docucmentation
44

55
# {{ page.title}}
66

7-
Scala3doc has similar functionalites to [Jekyll](http://jekyllrb.com/) to allow users to documentation in form of static sit alongside your APIs. Moreover having a combined tool allows provide reach interaction between those to such as linking thus allowing the two to
8-
blend naturally.
7+
Scala3doc is able to generate static sites, known from [Jekyll](http://jekyllrb.com/) or [Docusaurus](https://docusaurus.io/).
8+
Having a combined tool allows to provide interaction between static documentation and API thus allowing the two to blend naturally.
99

1010
Creating a site is just as simple as in Jekyll. The site root contains the
1111
layout of the site and all files placed here will be either considered static,
@@ -42,13 +42,13 @@ is parsed and put into the `page` variable available in templates via Liquid.
4242

4343
Scala3doc uses some predefied properties to controls some aspect of page.
4444

45-
Predefiend properties:
45+
Predefined properties:
4646

4747
- **title** provide page title that will be used in navigation and html metadata.
4848
- **extraCss** additional `.css` files that will be included in this page. Paths should be relative to documentation root. **This setting is not exported to template engine**
4949
- **extraJs** additional `.js` files that will be included in this page. Paths should be relative to documentation root. **This setting is not exported to template engine**
50-
- **hasFrame** when set to `false` page will not include default layout (navigation, breadcrumbs etc.) but only token html wrapper to provide metadata and resources (js and css files)
51-
- **layout** - predefined layout to use, see below
50+
- **hasFrame** when set to `false` page will not include default layout (navigation, breadcrumbs etc.) but only token html wrapper to provide metadata and resources (js and css files). **This setting is not exported to template engine**
51+
- **layout** - predefined layout to use, see below. **This setting is not exported to template engine**
5252

5353

5454
## Using existing Templates and Layouts
@@ -114,7 +114,7 @@ The `sidebar` key is mandatory, as well as `title` for each element. The
114114
default table of contents allows you to have subsections - albeit the current
115115
depth limit is 2 however it accepts both files and directories and latter can be used to provide deeper structures.
116116

117-
The items which have the `subsection` does not accepts `url` section.
117+
The items which have on the `subsection` level does not accepts `url`.
118118

119119
```
120120
├── blog

0 commit comments

Comments
 (0)