Skip to content

Commit 26237f7

Browse files
committed
add clarification about documentation style guide
1 parent 5976d83 commit 26237f7

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
1. Review this guide completely
66
2. Setup you development environment
7-
3. Familiarize yourself with our style guide
7+
3. Familiarize yourself with our documentation style guide
88

99
## Development setup
1010

@@ -78,7 +78,7 @@ This will be enough to work on Platform, Academy and, OpenAPI. If you want to wo
7878

7979
You should be able to open https://docs.apify.loc in your browser and run all the repositories jointly as one project.
8080

81-
## Style guide
81+
## Documentation style guide
8282

8383
### Language guidelines
8484

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ Our documentation ecosystem consists of:
2525

2626
Before contributing, read these essential resources:
2727

28-
- [Contributing Guidelines](CONTRIBUTING.md)
29-
- [Style Guide](CONTRIBUTING.md#style-guide)
28+
- [Contributing guidelines](CONTRIBUTING.md)
29+
- [Documentation style guide](CONTRIBUTING.md#style-guide)
3030

3131
## Documentation architecture
3232

@@ -59,5 +59,5 @@ Our documentation is built using:
5959
## Need help
6060

6161
- For contribution questions, see our [Contributing Guidelines](CONTRIBUTING.md)
62-
- For technical issues, create a GitHub issue
63-
- For documentation feedback, use the feedback form on our documentation pages
62+
- For technical issues, [create a GitHub issue](https://github.com/apify/apify-docs/issues/new)
63+

0 commit comments

Comments
 (0)