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

Create user guide #73

Merged
merged 6 commits into from
Nov 15, 2024
Merged

Create user guide #73

merged 6 commits into from
Nov 15, 2024

Conversation

Misty-W
Copy link
Collaborator

@Misty-W Misty-W commented Nov 8, 2024

Add user guide for UCC covering

  • Intro
  • Installation
  • Basic usage
  • Key modules
  • Customization
    • Settings
    • Writing a custom pass
    • Adding a pass to the UCC transpilation sequence
  • Terminology clarification

@Misty-W Misty-W linked an issue Nov 8, 2024 that may be closed by this pull request
@Misty-W Misty-W assigned Misty-W and unassigned Misty-W Nov 8, 2024
@Misty-W Misty-W force-pushed the 54-create-user-guide branch from e36973a to 3c3b856 Compare November 8, 2024 02:58
@jordandsullivan
Copy link
Collaborator

Just checking, it looks like we would need to install the myst-parser in order to use .md files with sphinx. Do we want to jump in on this dependency or hold off?

@Misty-W
Copy link
Collaborator Author

Misty-W commented Nov 8, 2024

Just checking, it looks like we would need to install the myst-parser in order to use .md files with sphinx. Do we want to jump in on this dependency or hold off?

Good catch, I converted the user guide to .rst.

Copy link
Collaborator

@jordandsullivan jordandsullivan left a comment

Choose a reason for hiding this comment

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

LGTM. Do we also want to add the individual pass modules to the API guide do you think?

@Misty-W
Copy link
Collaborator Author

Misty-W commented Nov 15, 2024

LGTM. Do we also want to add the individual pass modules to the API guide do you think?

thanks Jordan! Yes, I've added them.

@Misty-W Misty-W merged commit eb244c7 into main Nov 15, 2024
@Misty-W Misty-W deleted the 54-create-user-guide branch November 15, 2024 00:06
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.

Create user guide
2 participants