Skip to content

Commit a4976b6

Browse files
authored
Update README.md
1 parent 2e1b1ae commit a4976b6

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
# Text Forge Online Documentation
2+
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/text-forge/docs/mkdocs.yml?label=build%20%26%20deploy)
23

34
This repository is build and deploy place for main project docs. It means all docs (everything in `docs/` directory) copied from [here](https://github.com/text-forge/text-forge/tree/Main/docs)
45
(by GitHub Actions), and then built and deployed. This repository was created solely for the purpose of using the link `text-forge.github.io/docs` instead of `text-forge.github.io/text-forge`, and
56
also includes configuration files. With this in mind, please use the `docs/` folder in the main project repository ([here](https://github.com/text-forge/text-forge/tree/Main/docs)) to make changes
67
to the documentation.
78

89
> [!Important]
9-
> Only `mkdocs.yml` and other configuration files (e.g. workflows) can be changed directly in this repo. Other changes will be sync by [`github-actions[bot]`](https://github.com/apps/github-actions).
10+
> `mkdocs.yml` and `docs/` directory will be sync by [`github-actions[bot]`](https://github.com/apps/github-actions), don't change them directly.

0 commit comments

Comments
 (0)