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

[docs] MICRO 2019 Documentation Cleanup #400

Merged
merged 26 commits into from
Oct 8, 2019
Merged

[docs] MICRO 2019 Documentation Cleanup #400

merged 26 commits into from
Oct 8, 2019

Conversation

abejgonzalez
Copy link
Contributor

@abejgonzalez abejgonzalez commented Sep 25, 2019 •
edited

Related issue:

Type of change: other enhancement

Impact: no rtl change

Development Phase: implementation

Release Notes
This is the start of cleaning up BOOMs documentation before the MICRO 2019 Chipyard tutorial.

  • Test bibliography vs endnotes (if endnotes better... delete bibliography)
  • Add more definitions
  • Change code sections to link to code instead of copying it (e.g. literalinclude)
  • Update diagrams
  • Point to updated Chipyard documentation

@abejgonzalez abejgonzalez self-assigned this Sep 25, 2019
jerryz123
jerryz123 reviewed Sep 25, 2019
View reviewed changes
docs/sections/boom-ecosystem.rst Outdated Show resolved Hide resolved
docs/sections/intro-overview/boom-pipeline.rst Outdated Show resolved Hide resolved
docs/sections/intro-overview/rocket-chip.rst Outdated Show resolved Hide resolved
@abejgonzalez
clean up :code: | literalinclude code blocks [ci skip]
0c1097e
@abejgonzalez
template to point to chipyard docs | address comments [ci skip]
38edd3d
@abejgonzalez
added the :term: keyword to link to terminology section [ci skip]
d5c23b0
@abejgonzalez
update a bit more (decode, exe, issues, rename, rob, regfile
f2a689b
@abejgonzalez
update structure | remove bib [ci skip]
cac2705
@abejgonzalez
testing pictures [ci skip]
c4e21d8
@abejgonzalez
try _static [ci skip]
697f125
@abejgonzalez
more cleanup [ci skip]
41b96df
@abejgonzalez
update spaces [ci skip]
8590a94
@abejgonzalez
fetch/decode/bpu cleanup [ci skip]
29ddbe3
@abejgonzalez
bug fixes [ci skip]
c038596
@abejgonzalez
remove static test [ci skip]
4200e6d
@abejgonzalez
cleanup terms | fix rocket chip working [ci skip]
8b11b82
@abejgonzalez
readd bibliography [ci skip]
3c42f8b
@abejgonzalez
try to rescale [ci skip]
e46c0c0
@abejgonzalez
update image [ci skip]
85f6c6f
@abejgonzalez
update image [ci skip]
b1b7c37
@abejgonzalez
update image [ci skip]
975819d
@abejgonzalez
update image [ci skip]
0f523d8
@abejgonzalez
update physical-vlsi section [ci skip]
c09a23d
@abejgonzalez
update future work header [ci skip]
d326806
jerryz123
jerryz123 requested changes Oct 8, 2019
View reviewed changes
docs/index.rst Show resolved Hide resolved
docs/sections/boom-ecosystem.rst Outdated Show resolved Hide resolved
docs/sections/reorder-buffer.rst Outdated Show resolved Hide resolved
jerryz123
jerryz123 approved these changes Oct 8, 2019
View reviewed changes
Copy link
Contributor

@jerryz123 jerryz123 left a comment

Choose a reason for hiding this comment

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

Minor nits, primarily focused on the new text, and not on the cleaner headings/links/etc.

@abejgonzalez abejgonzalez merged commit 02d9506 into master Oct 8, 2019
@abejgonzalez abejgonzalez deleted the cleanup-docs branch October 8, 2019 06:26
jerryz123 pushed a commit that referenced this pull request Mar 11, 2021
@sagark @abejgonzalez
Fix changelog formatting (#400)
ca653c0
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jerryz123 jerryz123 jerryz123 approved these changes

@mehnadnerd mehnadnerd Awaiting requested review from mehnadnerd

@bkorpan bkorpan Awaiting requested review from bkorpan

Assignees

@abejgonzalez abejgonzalez

Labels
cleanup docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@abejgonzalez @jerryz123