Skip to content

Update documentation link in README.md #1016

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

Merged
andrykonchin merged 2 commits into from
Jun 1, 2026
+2 −2
Merged

Update documentation link in README.md #1016

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63f4832
Fix documentation GitHub Action and avoid nesting guides into book di…
andrykonchin Jun 1, 2026
fe0bfb9
Update README.md and provide a link to the guides
andrykonchin Jun 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ jobs:
- name: Move into a dedicated subdirectory
run: |
mkdir -p combined-docs/guides
cp -r book/ combined-docs/guides
cp -r book/* combined-docs/guides

- name: Upload static files as artifact
id: deployment
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ end
## Documentation

* **API Reference:** Comprehensive documentation for all classes and methods is available on [RubyDoc.info](https://www.rubydoc.info/github/Dynamoid/dynamoid/).
* **User Guides:** Detailed overviews and usage examples for specific features can be found in the [`doc/`](./doc) directory.
* **User Guides:** For detailed overviews and usage examples of specific features, see the online [User Guides](https://dynamoid.github.io/dynamoid/guides/).


## Compatibility
Expand Down
Loading