Skip to content

Commit ac16ddf

Browse files
author
ADMSK\AVROGAL1
committed
Updates on readme
1 parent 770e51b commit ac16ddf

File tree

2 files changed

+59
-3
lines changed

2 files changed

+59
-3
lines changed

docs/README.md

+41-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,42 @@
1-
# Initial page
1+
# Getting Started
22

3+
## _Installation_
4+
5+
For full documentation visit [https://docs.gitbook.com/](https://docs.gitbook.com/).
6+
7+
## _Description_
8+
9+
With the help of _**GitBook**_ you can create and develop documentation on Kotlin Design patterns.
10+
11+
## _Project Structure_
12+
13+
```text
14+
mkdocs.yml # Configuration file.
15+
docs/
16+
index.md # Documentation homepage
17+
units/
18+
design-patterns.md # Design patterns and architectural concepts
19+
scenarios.md # Scenarios in practice
20+
use-cases.md # Typical use cases
21+
user-guide/
22+
changelog.md # Changelog page
23+
code_of_conduct.md # Code of conduct page
24+
code_owners.md # Code owners page
25+
dependency.md # Dependency page
26+
description.md # Description page
27+
faq.md # FAQ page
28+
getting-started.md # Getting started page
29+
troubleshooting.md # Troubleshooting page
30+
upgrade.md # Upgrade page
31+
reporting/
32+
info.md # Informational page
33+
issue_template.md # Issue template page
34+
bug_report.md # Bug report template
35+
custom_report.md # Custom report template
36+
feature_request_template.md # Feature request template
37+
pull_request_template.md # Pull request template
38+
contributing/
39+
info.md # Contribution page
40+
links/
41+
info.md # Contribution page
42+
```

docs/SUMMARY.md

+18-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,20 @@
11
# Table of contents
22

3-
* [Initial page](README.md)
4-
3+
* [Getting Started](README.md)
4+
* [Contributing](contributing/README.md)
5+
* [Contributing](contributing/info.md)
6+
* [User Guide](user-guide/README.md)
7+
* [Upgrading](user-guide/upgrade.md)
8+
* [Troubleshooting](user-guide/troubleshooting.md)
9+
* [Getting Started](user-guide/getting-started.md)
10+
* [FAQ](user-guide/faq.md)
11+
* [Changelog](user-guide/changelog.md)
12+
* [Code Owners](user-guide/code_owners.md)
13+
* [Code of Conduct](user-guide/code_of_conduct.md)
14+
* [Dependency Management](user-guide/dependency.md)
15+
* [Links](links/README.md)
16+
* [Resources](links/info.md)
17+
* [Units](units/README.md)
18+
* [Scenarios](units/scenarios.md)
19+
* [Use Cases](units/use-cases.md)
20+
* [Design Patterns](units/design-patterns.md)

0 commit comments

Comments
 (0)