Commit Graph

29 Commits

Author SHA1 Message Date
spolifroni-amd
ae5bf79b77 edited the contributing section (#3981)
* removed the building doc; edited toolchain to remove myst; made the fact that rst is the preferred format evident

* edited the readme so that it points to the contributing to the rocm docs page

* Update docs/contribute/contributing.md

Co-authored-by: Peter Park <peter.park@amd.com>

* Update docs/contribute/contributing.md

Co-authored-by: Peter Park <peter.park@amd.com>

* added two images showing where the checks and doc build is

---------

Co-authored-by: Peter Park <peter.park@amd.com>
2024-11-18 14:15:01 -05:00
Sam Wu
abc0e6a087 Add building doc section (#3873) 2024-10-08 10:01:17 -06:00
spolifroni-amd
f86f275cf1 Restructured the contributions section. (#3715)
* testing if this file is editable

* changed 'kebob-case' to 'dash-case'

* Restructured the page to be more straightforward and provide additional repo information

* forgot to save

* Moved the topic sentence

* Wrong accent on the a in diataxis

* Removed the feedback info from contributing and moved it to Feedback

* fixed spelling errors

* fixed some wording and removed second person text

* consolidated Build and Structure into Contribute; edited toolchai to (hopefully) conform to style guide; updated toc

* updated the titles in the toc

* made changes based on feedback

* it's better when you save

* removed structure and build; fixed something for the linter

* added rst to wordlist

* added customizations to wordlist
2024-10-01 13:59:51 -04:00
spolifroni-amd
a09fabfc84 Updated the Feedback section (#3523)
* Rewrote the section to be minimalist and not specify the number of ways to provide feedback. Also removed the PR info since that's covered in Contributing.

* Update feedback.md

Got feedback from Leo about how to improve on this and make it conform to the style guide. Updated with changes based on that feedback.
2024-08-15 10:28:25 -06:00
Sam Wu
33ce708926 Sync develop branch 2024-08-02 11:13:45 -06:00
spolifroni-amd
b6a305f924 made the linter happy 2024-08-02 10:55:56 -04:00
Sandra Polifroni
531796f523 removed all references to the feedback email 2024-08-02 10:40:53 -04:00
Young Hui - AMD
9de6c61100 fix linting and update 6.2 stack image (#123) 2024-07-31 18:57:19 -04:00
randyh62
647634a976 Update ROCm component links (#116)
* Update ROCm component links

* link update

* correct rocal

* change ROCm Compilers link

* update llvm-project reference for rocmcc

* use llvm-project for Clang

* reorder links to match image

* fix link format

* Update rocm-tools.md

fix link syntax

* add spell checking note

* may to might

* add compilers to tools

* update what-is-rocm image

* Young's comments

* Leo's comments

* tools, compiler, and runtimes

* move hipify

* Perter's comments
2024-07-31 13:27:28 -07:00
Sam Wu
3ab619ffc4 Add more explanation about doc requirements (#3108)
* Add more explanation about doc requirements

* Fix spelling
2024-05-09 10:22:52 -06:00
randyh62
47192a92ba added Getting ROCm Source Files (#2952)
* added Accessing ROCm Source Files

* changed per comments

* Update README.md

implement dgaliffi suggestions

Co-authored-by: David Galiffi <dgaliffi@amd.com>

* Update README.md

implement dgailifi suggestion

Co-authored-by: David Galiffi <dgaliffi@amd.com>

* Update README.md

implement dgailifi suggestion

Co-authored-by: David Galiffi <dgaliffi@amd.com>

* Update README.md

implement dgailifi suggestion

Co-authored-by: David Galiffi <dgaliffi@amd.com>

* add default.xml link

* update README

---------

Co-authored-by: David Galiffi <dgaliffi@amd.com>
2024-03-07 14:41:39 -08:00
Istvan Kiss
e4c0cf9044 Branch rebase fix (#2916) 2024-02-29 15:05:49 -07:00
randyh62
e5d86c4433 Update contributing.md (#2921)
reordered doc build commands
2024-02-22 09:44:04 -08:00
Lisa
d64d5e6750 Update build commands (#2917)
Co-authored-by: Sam Wu <sam.wu2@amd.com>
2024-02-21 13:53:03 -07:00
Istvan Kiss
67e3fc994b MI300 documentation (#2779)
---------

Co-authored-by: Nagy-Egri Máté Ferenc <mate@streamhpc.com>
Co-authored-by: Lisa Delaney <lisa.delaney@amd.com>
Co-authored-by: Davide Teixeira <77169625+daviteix@users.noreply.github.com>
2024-02-20 17:02:36 -07:00
Istvan Kiss
02cc970a75 Update github links to ROCm organization 2024-02-09 17:03:40 +01:00
Lisa
3c94962813 new banner images (#2884) 2024-02-08 11:53:48 -07:00
Lisa
8bbd51376d update contributing section & update card images (#2865) 2024-02-07 09:31:45 -07:00
Lisa
d399b13c88 add keywords (#2799) 2024-01-11 14:07:30 -07:00
yhuiYH
eeb96ebb18 Move documentation contributing.md and add Governance.md and Contributing.md (#2690)
* moved contributing.md to new location as it describes contributing to documentation

* Adding Governance.md and high-level Contributing.md

* fix linting errors (asterisk, whitespace and unused links)

* More linting fixes

* merge conflicts

* verbiage

* License link moved out of codeblock, and text fix there. Changed to full name of AMD. Update links to ROCm Org path

* whitespace linting fix

* Reverted back to ROCm is lead and managed by AMD.  Flows better to me.

---------

Co-authored-by: Lisa Delaney <lisa.delaney@amd.com>
2023-12-15 16:14:13 -07:00
Lisa
3aa7072fc2 metadata test (#2656) 2023-11-30 14:37:12 -07:00
Lisa
c6e2856822 Update style guidelines (#2542) 2023-10-12 13:50:15 -06:00
Lisa
7b3e6364f9 Email link update (#2517) 2023-09-29 10:27:20 -06:00
Lisa
940d2933ff Link and formatting fixes (#2482) 2023-09-20 09:55:21 -06:00
Lisa
d0d4eed1a6 Update titles to sentence case (#2455) 2023-09-18 12:26:31 -06:00
Lisa
7c5976004f ROCm A-Z page & link cleanup (#2450) 2023-09-13 13:00:50 -06:00
Lisa
890c735f53 site restructure phase 1 - file reorganization (#2428) 2023-09-08 10:02:17 -06:00
Sam Wu
14153b9540 fix typos and add links to rocm-docs-core user and developer guides in contributing section (#2372) 2023-08-09 14:02:05 -06:00
Sam Wu
5f546d44b3 Update Toolchain and Contributing Guides (#2315)
* spell out HPC acronym in explanation doc

* update toolchain docs

order in importance descending

* update Contributing guide

add discussions

update formatting and grammar

* separate contributing section for readability

* fix formatting for mdl

* fix spelling
2023-07-25 10:29:45 -06:00