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

Documentation update #141

Merged
merged 40 commits into from
Oct 25, 2022
Merged

Documentation update #141

merged 40 commits into from
Oct 25, 2022

Conversation

troelsfr
Copy link
Contributor

@troelsfr troelsfr commented Sep 26, 2022 •
edited

This PR

  • Adds new documentation and provides a number of concrete examples on how to use QAT
  • Revise and cleans up naming
  • Makes QAT more consistent with the QIR spec
  • Moves target definition completely out of QAT

@troelsfr
Updating docs
f8648b4
@troelsfr
Merge branch 'main' into feature/documentation-update
2feff84
@troelsfr
Updating examples
ed82f29
@troelsfr
Fixing formatting errors
119681f
@troelsfr
Updating docs
7258859
@troelsfr
Fixing tables
587412b
@troelsfr
Preparing refactor
eed7315
@troelsfr
Updating targets
cae3208
@troelsfr
Updating CLI tests
be78888
@troelsfr
Updating test to use configuration files
2b7ce87
@troelsfr
Formatting
1677f41
@troelsfr
Refactoring to get more sensible names and help pages
95d6c36
@troelsfr
Updating style
506f329
@troelsfr
Moving the home of rule factory
9c0a27b
@troelsfr
Fixing tests
7ee9510
@troelsfr
Fixing Bazel tests
aabe6db
@troelsfr
Fixing YMAL formatting
81ef141
@troelsfr
Renaming rule transformation adaptor
4a62854
@troelsfr
Finalising renaming
2e76fc0
@troelsfr
Wrapping overview up
f4f901e
@troelsfr
Updating with more examples
288235c
@troelsfr
Formatting
67e46ac
@troelsfr
Renaming adaptor name
8437e24
@troelsfr
Fixing tests
3e1c58a
@troelsfr
Updating CI scripts
c179f99
@troelsfr
FIxing CI scripts
d628e8e
@troelsfr
Fixing line lengths
554a4ab
@troelsfr
Fixing link
4a4eb1a
@troelsfr
Updating README
75f27ac
@troelsfr
Adding introduction
0d01e7a
@troelsfr troelsfr marked this pull request as ready for review October 5, 2022 14:38
@troelsfr troelsfr requested a review from swernli as a code owner October 5, 2022 14:38
bettinaheim
bettinaheim approved these changes Oct 24, 2022
View reviewed changes
Copy link
Member

@bettinaheim bettinaheim left a comment

Choose a reason for hiding this comment

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

Please take a look and address the comments as appropriate before merging. All in all, looks great!

README.md Show resolved Hide resolved
docs/src/QuickStart/building-with-bazel.md Outdated Show resolved Hide resolved
docs/src/QuickStart/building-with-cmake.md Outdated Show resolved Hide resolved
docs/src/QuickStart/building-with-cmake.md Outdated Show resolved Hide resolved
docs/src/QuickStart/building-with-bazel.md Outdated Show resolved Hide resolved
docs/src/QuickStart/index.md Outdated Show resolved Hide resolved
docs/src/DeveloperGuide/WritingAdaptor.md Outdated Show resolved Hide resolved
docs/src/DeveloperGuide/WritingAdaptor.md Outdated Show resolved Hide resolved
docs/src/DeveloperGuide/WritingAdaptor.md Show resolved Hide resolved
docs/src/DeveloperGuide/WritingAdaptor.md Outdated Show resolved Hide resolved
troelsfr and others added 8 commits October 24, 2022 08:27
@troelsfr @bettinaheim
Update docs/src/QuickStart/building-with-cmake.md
334c023 
Co-authored-by: Bettina Heim <heimb@outlook.com>
@troelsfr @bettinaheim
Update docs/src/UsingQAT/TargetingQIR.md
0eeb931 
Co-authored-by: Bettina Heim <heimb@outlook.com>
@troelsfr @bettinaheim
Update docs/src/UsingQAT/TargetingQIR.md
63ea474 
Co-authored-by: Bettina Heim <heimb@outlook.com>
@troelsfr
PR updates
1aea5b9
@troelsfr
Merge branch 'feature/documentation-update' of github.com:troelsfr/qa…
c788c4d 
…t into feature/documentation-update
@troelsfr
Updating
cdd8d93
@troelsfr
Formatting
769300a
@troelsfr
Updating wording
b12c080
@troelsfr troelsfr merged commit d3541a1 into qir-alliance:main Oct 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bettinaheim bettinaheim bettinaheim approved these changes

@swernli swernli Awaiting requested review from swernli swernli is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@troelsfr @bettinaheim