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.

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

Improve docs #235

Merged
merged 6 commits into from
Aug 12, 2023
Merged

Improve docs #235

merged 6 commits into from
Aug 12, 2023

Conversation

christiangnrd
Copy link
Contributor

@christiangnrd christiangnrd commented Aug 11, 2023

  • Fix some typos
  • Repair/remove broken links
  • Reorganize to match CUDA.jl better and include already-written documentation
  • Julia packages is not shown in the Metal v0.3 Metal.versioninfo(). So fix that. I used v1.9.3 because that version avoids the intermittent bus errors (see Crash during MTLDispatchListApply #225)

This also fixes the doctests which prevented the 0.5.0 docs from being generated.

Doc preview

- Fix some typos
- Repair/remove broken links
- Reorganize to match CUDA.jl better and include already-written documentation
Julia packages is not shown in Metal v0.3
@christiangnrd
Copy link
Contributor Author

I removed the video link in index.md because I couldn't find the video. If it does end up getting removed, it should also be removed in the CUDA docs

@christiangnrd
Copy link
Contributor Author

All changes are either for documentation or for consistency (related to documentation).

I'm done making commits on this pull request. If I have any more improvements I'll make a new one.

@maleadt
Copy link
Member

maleadt commented Aug 12, 2023

LGTM, thanks. At some point we should think about merging the docs for all back-ends though; it doesn't make sense to keep on duplicating and slightly modifying things.

@maleadt maleadt merged commit 5d60a36 into JuliaGPU:main Aug 12, 2023
@christiangnrd christiangnrd deleted the christiangnrd-patch-1 branch August 17, 2023 14:25
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.

2 participants