Skip to content

docs: fix stale file paths in CONTRIBUTING and server-config#663

Open
ZayanKhan-12 wants to merge 1 commit into
tableau:masterfrom
ZayanKhan-12:docs/fix-stale-paths
Open

docs: fix stale file paths in CONTRIBUTING and server-config#663
ZayanKhan-12 wants to merge 1 commit into
tableau:masterfrom
ZayanKhan-12:docs/fix-stale-paths

Conversation

@ZayanKhan-12

Copy link
Copy Markdown

Three stale paths, verified against the current tree:

  • CONTRIBUTING.md references docs/server-startup.md twice (markdown-toc command and the "Server Startup Guide" link) — that file doesn't exist; the startup/installation guide is docs/server-install.md.
  • CONTRIBUTING.md tells contributors to update tabpy/tabpy-server/state.ini — the directory is tabpy/tabpy_server (underscore).
  • docs/server-config.md links the default config as tabpy-server/tabpy_server/common/default.conf, a pre-restructure path that resolves nowhere (doubly so from inside docs/); now ../tabpy/tabpy_server/common/default.conf.

Verification: target files confirmed present at the corrected paths; pytest tests/unit passes locally (102 passed; Python 3.14, macOS arm64).

Prepared with AI assistance (Claude).

- 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 <noreply@anthropic.com>
@salesforce-cla

Copy link
Copy Markdown

Thanks for the contribution! Before we can merge this, we need @zk-khan to sign the Salesforce Inc. Contributor License Agreement.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants