Fix doc links (#884)

[dtchepak]

• move /docs to /help
• remove dates from doc names
• move docs to sub-directories and rename to index.md so we get nice urls (e.g. help/example rather than help/example.html.
• use wget --spider to detect and fix broken links.
• fix search rendering. Note: dark mode does not play nicely with the GCSE input box1
• rearrange home page to put install links at the top

[Romfos]

I propose to don't do subdirectories
URLs without *.html works automatically. example: https://nsubstitute.github.io/docs/2010-02-10-replacing-return-values
Looks like this is local debug server bug
Make sense just remove dates because solution with index.html looks strange

@dtchepak WDYT?

[dtchepak]

I propose to don't do subdirectories URLs without *.html works automatically. example: https://nsubstitute.github.io/docs/2010-02-10-replacing-return-values Looks like this is local debug server bug Make sense just remove dates because solution with index.html looks strange

@dtchepak WDYT?

I'm not sure about this. 🤔 It is relying on github pages specific implementation right? I kind of like being able to do python3 -m http.server 8080 -d _site and have it be representative of what the real site will look like. If you feel strongly about it though i'm happy to update this PR as suggested 👍

[Romfos]

you can avoid manually working with paths

var fileName = Path.GetFileNameWithoutExtension(markdownFile.Path);
var directoryName = new FileInfo(markdownFile.Path).Directory.Name;
var nameToUse = string.Equals(fileName, "index", StringComparison.InvariantCultureIgnoreCase) ? directoryName  : fileName;
return $"Tests_{nameToUse.Replace("-", "_")}";

[dtchepak]

Applied suggestion 👍

[Romfos]

I propose to don't do subdirectories URLs without *.html works automatically. example: https://nsubstitute.github.io/docs/2010-02-10-replacing-return-values Looks like this is local debug server bug Make sense just remove dates because solution with index.html looks strange
@dtchepak WDYT?

I'm not sure about this. 🤔 It is relying on github pages specific implementation right? I kind of like being able to do python3 -m http.server 8080 -d _site and have it be representative of what the real site will look like. If you feel strongly about it though i'm happy to update this PR as suggested 👍

If we need support other platforms then github pages - maybe this is fine

[Copilot]

Pull Request Overview

This PR fixes and improves documentation links by moving content from the /docs to the /help directory, updating URL patterns, and adjusting tests accordingly.

• Update csproj file to recursively include markdown files from the new docs structure.
• Refactor test file name generation to accommodate renamed and reorganized documentation files.
• Update table of contents and link references to point to the new /help location and remove outdated docs.

Reviewed Changes

Copilot reviewed 10 out of 34 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
tests/NSubstitute.Documentation.Tests/NSubstitute.Documentation.Tests.csproj	Updated wildcard inclusion for markdown files in the new structure
tests/NSubstitute.Documentation.Tests.Generator/DocumentationTestsGenerator.cs	Modified test class name generation to consider folder names
docs/toc.yml	Updated links from docs/ to help/
docs/index.md	Added download sidebar and restructured the documentation home page
docs/help/toc.yml	New table of contents for the help directory
docs/help/search/index.md	New search page with Google CSE integration
docs/help/creating-a-substitute/index.md	Updated link for "How NSubstitute works" for correct trailing slash
docs/help.md	Updated links from /docs/ to /help/
docs/docs/toc.yml	Removed outdated table of contents for legacy docs
docs/docs/2019-01-01-search.md	Deleted outdated search page

[304NotModified]

@Romfos could you merge this pr? Would be great to see the links working again.

[Romfos]

@304NotModified I don't have merge permission. We need wait @dtchepak for feedback

[304NotModified]

Unfortunately I also don't have merge permission

[dtchepak]

@304NotModified I don't have merge permission. We need wait @dtchepak for feedback

I think I've fixed this now @304NotModified and @Romfos 🤞
Let me know if you still do not have permission.

[Romfos]

@dtchepak yes, I have it. Please deploy new version after fix

[dtchepak]

Deployed ✔️