Skip to content

Commit 7ab61b1

Browse files
authored
Create README.md
1 parent 3e0f32f commit 7ab61b1

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Text Forge Online Documentation
2+
3+
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)
4+
(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
5+
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
6+
to the documentation.
7+
8+
> [!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).

0 commit comments

Comments
 (0)