Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Migrate documentation to docfx #850

Merged
merged 7 commits into from
Dec 15, 2024
Merged

Migrate documentation to docfx #850

merged 7 commits into from
Dec 15, 2024

Conversation

Romfos
Copy link
Contributor

@Romfos Romfos commented Dec 4, 2024 •
edited
Loading

Changes:

  • Documentation is migrated to docfx platform. https://github.com/dotnet/docfx
  • Github actions are updated
  • Ruby dependency is removed
  • Cleanup & update some test dependencies for build.fsproj
  • Fix pipeline link in readme

related: #269

@Romfos Romfos requested a review from dtchepak December 4, 2024 11:22
@Romfos Romfos marked this pull request as ready for review December 4, 2024 11:25
@Romfos Romfos mentioned this pull request Dec 4, 2024
Open
13 tasks
@Romfos
Copy link
Contributor Author

Romfos commented Dec 4, 2024 •
edited
Loading

I would like to inform you that documentation release now is decoupled from package release.
You can release documentation any moment of time

After merge this PR:

  1. You can go https://github.com/nsubstitute/NSubstitute/actions/workflows/release_documentation.yml
  2. Run pipeline and get generated documentation from pipeline artifacts

dtchepak
dtchepak approved these changes Dec 8, 2024
View reviewed changes
Copy link
Member

@dtchepak dtchepak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Is there a sample build to view? (is there much output diff compared to previously generated site?

docs/index.md Outdated
Comment on lines 44 to 49
<pre>

```text
ReceivedCallsException : Expected to receive a call matching:
Add(1, 2)
Actually received no matching calls.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: do we need both <pre /> and code fence (triple back-tick) here?

Copy link
Contributor Author

@Romfos Romfos Dec 8, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

removed

@Romfos
Copy link
Contributor Author

Romfos commented Dec 8, 2024

Nice! Is there a sample build to view? (is there much output diff compared to previously generated site?

you can check it locally if you git pull this branch

  1. open terminal in /docs folder
  2. dotnet tool install -g docfx
  3. docfx build --serve --open-browser

@dtchepak dtchepak merged commit d0ff096 into nsubstitute:main Dec 15, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dtchepak dtchepak dtchepak approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Romfos @dtchepak