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

add docs for autocompletions and forc init template #899

Merged
merged 6 commits into from
Mar 8, 2022

Conversation

JoshuaBatty
Copy link
Member

Question, @adlerjohn do we want to embed the autocompletions gif at the end of that section? Or would we prefer to keep the sway book text only?

mitchmindtree
mitchmindtree previously approved these changes Mar 8, 2022
@adlerjohn
Copy link
Contributor

do we want to embed the autocompletions gif at the end of that section? Or would we prefer to keep the sway book text only?

Up to you. I think images are fine so long as it's not overdone.

@adlerjohn adlerjohn added the The Sway Book Everything to do with the Sway Book label Mar 8, 2022
@JoshuaBatty
Copy link
Member Author

I've created a new media folder inside of docs as a place where we can store things like images and gifs for the sway book. If anyone has any objections to this or another suggestion for where we should host media files, feel free to chime in.

@adlerjohn
Copy link
Contributor

Media is fine. Does it actually get compiled properly with mdbook?

@JoshuaBatty
Copy link
Member Author

Good call, just built the book locally and it doesn't seem to copy the file into the book when it's built. Seems like it only works if the gif link is a URL.

Copy link
Contributor

@adlerjohn adlerjohn left a comment

Choose a reason for hiding this comment

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

We probably shouldn't rely on a remote source for images IMO. If we can't include it locally then better to not include it at all.

@JoshuaBatty
Copy link
Member Author

We probably shouldn't rely on a remote source for images IMO. If we can't include it locally then better to not include it at all.

Yep, fair enough. I'll remove it.

Copy link
Contributor

@adlerjohn adlerjohn left a comment

Choose a reason for hiding this comment

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

Can you remove the actual file too? docs/media/forc_auto_complete.gif looks like it's still there

@JoshuaBatty JoshuaBatty merged commit 10a78cf into master Mar 8, 2022
@JoshuaBatty JoshuaBatty deleted the josh/sway_docs branch March 8, 2022 22:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
The Sway Book Everything to do with the Sway Book
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants