Skip to content

Consolidate docs in hipfile/docs#94

Merged
derobins merged 2 commits into
developfrom
derobins/consolidate_documentation
Nov 25, 2025
Merged

Consolidate docs in hipfile/docs#94
derobins merged 2 commits into
developfrom
derobins/consolidate_documentation

Conversation

@derobins
Copy link
Copy Markdown
Collaborator

Prep for rocFile removal

Prep for rocFile removal
Copilot AI review requested due to automatic review settings November 25, 2025 19:20
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR consolidates documentation from rocfile/docs into hipfile/docs in preparation for removing rocFile. Documentation files are being deleted from the rocFile directory and either moved or updated in the hipFile directory to reflect the hipFile API naming conventions.

Key Changes:

  • Removed all documentation files from rocfile/docs
  • Added/updated hipFile documentation with consistent API naming
  • Replaced "rocFile" references with "hipFile" throughout the documentation

Reviewed changes

Copilot reviewed 14 out of 15 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
rocfile/docs/rdma.rst Deleted RDMA documentation from rocFile
rocfile/docs/nvidia_compat.rst Deleted NVIDIA compatibility documentation from rocFile
rocfile/docs/introduction.rst Deleted introduction documentation from rocFile
rocfile/docs/file.rst Deleted file handle API documentation from rocFile
rocfile/docs/core.rst Deleted core API documentation from rocFile
rocfile/docs/config_build.rst Deleted configuration/build documentation from rocFile
hipfile/docs/rdma.rst Added RDMA documentation for hipFile
hipfile/docs/introduction.rst Updated introduction with comprehensive content for hipFile
hipfile/docs/file.rst Added file handle API documentation for hipFile
hipfile/docs/errors.rst Updated all API references from rocFile to hipFile
hipfile/docs/driver.rst Updated all API references from rocFile to hipFile with one typo
hipfile/docs/core.rst Added parameter getters/setters section to hipFile core documentation
hipfile/docs/batch.rst Updated API reference from rocFile to hipFile
hipfile/docs/async.rst Updated API reference from rocFile to hipFile

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread hipfile/docs/driver.rst Outdated
Comment thread hipfile/docs/driver.rst Outdated
@derobins derobins merged commit 5803337 into develop Nov 25, 2025
29 of 31 checks passed
@derobins derobins deleted the derobins/consolidate_documentation branch November 25, 2025 21:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants