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

docs: adding comments and a few other things #641

Merged
merged 2 commits into from
Apr 29, 2024
Merged

Conversation

kmurphypolygon
Copy link
Contributor

This PR does four things:

  • Removes the docs README which is not published.
  • Adds the comments function to all pages for community interactionl.
  • Changes the site_name.
  • Updates the run script so tech writers don't have to cd when working on the docs.

docs/index.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@Dominik1999 Dominik1999 left a comment

Choose a reason for hiding this comment

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

Looks good to me

docs/index.md Outdated
@@ -78,7 +78,7 @@ Accounts can expose any interface in the future. This is the Miden version of a

#### Customized note scripts

Users will be able to write their own note scripts using the Miden client. Note scripts are executed during note consumption and they can be arbitrarilyy complex due to the underlying Turing-complete Miden VM.
Users will be able to write their own note scripts using the Miden client. Note scripts are executed during note consumption and they can be arbitrarily complex due to the underlying Turing-complete Miden VM.
Copy link
Collaborator

Choose a reason for hiding this comment

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

nice find :)

@Dominik1999 Dominik1999 merged commit dd9667d into main Apr 29, 2024
9 checks passed
@Dominik1999 Dominik1999 deleted the docs/comments-2 branch April 29, 2024 16:14
@bobbinth
Copy link
Contributor

In the original PR we also added Documentation section to the main readme. Is this no longer needed?

@kmurphypolygon
Copy link
Contributor Author

kmurphypolygon commented Apr 30, 2024

We closed the other one. It is added here.

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.

3 participants