From e9c44de9e6a87637b6cd78607ada8de7405eeada Mon Sep 17 00:00:00 2001 From: Zayan Khan Date: Sun, 26 Jul 2026 20:06:15 -0400 Subject: [PATCH] docs: fix stale file paths in CONTRIBUTING and server-config - docs/server-startup.md does not exist; the startup guide is docs/server-install.md - the state file lives under tabpy/tabpy_server (underscore), not tabpy/tabpy-server - the default config link used the pre-restructure tabpy-server/ root and, being referenced from inside docs/, also needed ../ to resolve Co-Authored-By: Claude Fable 5 --- CONTRIBUTING.md | 6 +++--- docs/server-config.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7c740394..a616aa95 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -105,7 +105,7 @@ or npm [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli). TOC for markdown file is built with [markdown-toc](https://www.npmjs.com/package/markdown-toc): ```sh -markdown-toc -i docs/server-startup.md +markdown-toc -i docs/server-install.md ``` To check markdown style for all the documentation use `markdownlint`: @@ -120,7 +120,7 @@ These checks will run as part of the build if you submit a pull request. You can invoke the TabPy Server API against a running TabPy instance with Swagger. -- Make CORS related changes in TabPy configuration file: update `tabpy/tabpy-server/state.ini` +- Make CORS related changes in TabPy configuration file: update `tabpy/tabpy_server/state.ini` file in your local repository to have the next settings: ```config @@ -130,7 +130,7 @@ Access-Control-Allow-Headers = Origin, X-Requested-with, Content-Type Access-Control-Allow-Methods = GET, OPTIONS, POST ``` -- Start a local instance of TabPy server following [TabPy Server Startup Guide](docs/server-startup.md). +- Start a local instance of TabPy server following [TabPy Server Startup Guide](docs/server-install.md). - Run a local copy of Swagger editor with steps provided at [https://github.com/swagger-api/swagger-editor](https://github.com/swagger-api/swagger-editor). - Open `misc/TabPy.yml` in Swagger editor. diff --git a/docs/server-config.md b/docs/server-config.md index c57219e5..46d1221b 100755 --- a/docs/server-config.md +++ b/docs/server-config.md @@ -307,7 +307,7 @@ as explained in Python documentation at [Logging Configuration page](https://docs.python.org/3.6/library/logging.config.html). A default config provided with TabPy is at -[`tabpy-server/tabpy_server/common/default.conf`](tabpy-server/tabpy_server/common/default.conf) +[`tabpy/tabpy_server/common/default.conf`](../tabpy/tabpy_server/common/default.conf) and has a configuration for console and file loggers. Changing the config file allows the user to modify the log level, format of the logged messages and add or remove loggers.