Skip to content

Conversation

@lukasbriza
Copy link
Contributor

@lukasbriza lukasbriza commented Mar 12, 2025

Remove RELEASING.md and CONTRIBUTING.md and updating corresponding symlinks in docs/*.

@lukasbriza lukasbriza requested a review from adamkudrna as a code owner March 12, 2025 07:25
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 12, 2025
@mbohal
Copy link
Contributor

mbohal commented Mar 12, 2025

I think we should also do the same thing for the TESTING.md file. Presently it has the same content as src/docs/contribute/testing-guidelines.md, so I think we can:

  1. remove TESTING.md
  2. provide a link to src/docs/contribute/testing-guidelines.md from README.md

@lukasbriza
Copy link
Contributor Author

I think we should also do the same thing for the TESTING.md file. Presently it has the same content as src/docs/contribute/testing-guidelines.md, so I think we can:

1. remove `TESTING.md`

2. provide a link to `src/docs/contribute/testing-guidelines.md` from `README.md`

Added testing-guidelines.md into docs and deleting TESTING.md

@lukasbriza
Copy link
Contributor Author

@mbohal Should all links referencing parts of our documentation be internal links? I added links to the testing and releasing guidelines as external links, but for the testing link specifically, there’s no testing-guidelines.md file in master, so the GitHub check will fail due to a dead link. I'm wondering if it wouldn't be better to have all such references as internal links for consistency?

@mbohal
Copy link
Contributor

mbohal commented Mar 13, 2025

I'm wondering if it wouldn't be better to have all such references as internal links for consistency?

I think we want this. We need links to work in IDE and if relevant also in the mkdocs output.
I think we need to use the relative syntax (../../abc) for this.

@lukasbriza lukasbriza force-pushed the documentation/update-symlinks branch from b396e6f to 0cb5437 Compare March 18, 2025 06:08
@lukasbriza
Copy link
Contributor Author

After yesterday's call with @bedrich-schindler , it was decided to merge this task to enable further work on documenting the rules for writing Playwright tests.

@lukasbriza lukasbriza merged commit a7d1e91 into task/587 Mar 21, 2025
10 checks passed
@lukasbriza lukasbriza deleted the documentation/update-symlinks branch March 21, 2025 04:56
@adamkudrna adamkudrna linked an issue Mar 24, 2025 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update symlinks

3 participants