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

Fix typos, add note and rephrase sentences and commands #19

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

Perelyn-Arch
Copy link

No description provided.

Now that we've successfully compiled a program and executed it within the context of our Arch VM, let's dig into the details of how an Arch [program] is written and discuss some best practices.

In this section, we'll guide you through the basics of writing functions and handling input parameters effectively within a demo program: [GraffitiWall].
To illustrates the basic process involved in developing an Arch [program] we're going to build, deploy and interact with a demo program: [GraffitiWall].

Choose a reason for hiding this comment

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

This English doesn't make sense. I think it's a typo or something's missing.

Copy link
Author

Choose a reason for hiding this comment

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

My bad, It's the s in illustrates

Copy link
Author

Choose a reason for hiding this comment

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

Is this better?

To illustrate the process involved in developing an Arch [program] we're going to build, deploy and interact with a demo program: [GraffitiWall].

cf4488c

Copy link
Collaborator

Choose a reason for hiding this comment

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

It uses program twice which also doesn't read well, but we can probably remove that second program and just say "interact with our demo app," with the final result being:

To illustrate the basic process involved in developing an Arch [program], we're going to build, deploy and interact with our demo app: [GraffitiWall].

@@ -1,17 +1,17 @@
# Building, deploying and interfacing

Now that all of the dependencies are installed and we have successfully chosen a [development track], we can finally discuss program development, including compiling, deploying and interacting with it.
Now that all of the dependencies are installed and we have successfully chosen a [development stack], we can finally discuss program development, including compiling, deploying and interacting with it.

Choose a reason for hiding this comment

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

I think @waymobetta meant track because there were two different tracks in the documentation, but I'm not sure if that's still accurate.

Choose a reason for hiding this comment

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

I'm good with this if you're modifying this to refer to them as stacks as I'm not too picky on the nomenclature.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes, good find, this is from an older version of the docs that needs to be updated.

@Perelyn-Arch can you reprahase to the following:

Now that all of the dependencies are installed and we have successfully started our [development stack], we can finally discuss program development, including compiling, deploying and interacting with it.

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