Skip to content

Publish the EosSdkRpc HOWTO guide#3

Merged
TristanFloch merged 4 commits intomainfrom
first-guide
Jul 19, 2023
Merged

Publish the EosSdkRpc HOWTO guide#3
TristanFloch merged 4 commits intomainfrom
first-guide

Conversation

@TristanFloch
Copy link
Copy Markdown

@TristanFloch TristanFloch commented Jul 17, 2023

This PR aims at publishing the EosSdkRpc HOWTO guide.
It also translates Google Docs formatting to markdown with supported extensions.

I would advise following README's instructions for running the website locally and getting a preview of the guide in the website.

Note: #2 should be merged first.

@TristanFloch TristanFloch self-assigned this Jul 17, 2023
@TristanFloch TristanFloch force-pushed the first-guide branch 3 times, most recently from 2708621 to 10c49a1 Compare July 18, 2023 11:53
@TristanFloch TristanFloch marked this pull request as ready for review July 18, 2023 11:58
@TristanFloch TristanFloch force-pushed the first-guide branch 3 times, most recently from d1b36b3 to 05f4b0c Compare July 18, 2023 14:02
Copy link
Copy Markdown
Collaborator

@bradishp bradishp left a comment

Choose a reason for hiding this comment

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

The markdown document looks really nice.

I am just curious how different it is from the Google Docs version and how much effort was there in converting it. Any ideas for how we can ensure the two versions of the doc stay in sync?

Comment thread docs/guides/howto.md Outdated
@TristanFloch
Copy link
Copy Markdown
Author

TristanFloch commented Jul 18, 2023

I am just curious how different it is from the Google Docs version and how much effort was there in converting it. Any ideas for how we can ensure the two versions of the doc stay in sync?

Converting the document required the following steps:

  • Reapply/convert formatting to markdown (sections, inline code, bold and italic, bullet lists)
  • Creating notes blocks and other better adapted extended markdown features when it was appropriate
  • Rewrite tables in markdown (using copy/pasting and big regexps)
  • Creating code blocks with appropriate language code, file name, and line highlighting

This seems really hard to automate. I think a better solution would to make this markdown file our one and only version of the document. I added a note to discuss this in the next meeting @bradishp.

@bradishp
Copy link
Copy Markdown
Collaborator

This seems really hard to automate. I think a better solution would to make this markdown file our one and only version of the document. I added a note to discuss this in the next meeting @bradishp.

I completely agree that we should just maintain this version of the document going forward. Thanks for adding a note about this.

@TristanFloch TristanFloch force-pushed the main branch 3 times, most recently from 6f4832c to 65dfebc Compare July 19, 2023 16:51
@TristanFloch TristanFloch merged commit 41f7300 into main Jul 19, 2023
@TristanFloch TristanFloch deleted the first-guide branch July 19, 2023 16:55
@TristanFloch TristanFloch removed their assignment Aug 12, 2023
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.

2 participants