Skip to content
This repository has been archived by the owner on Jun 4, 2024. It is now read-only.

Add glossary for improved user understanding #700

Closed
wants to merge 1 commit into from

Conversation

ChinonyeRuth
Copy link

@ChinonyeRuth ChinonyeRuth commented May 4, 2024

This pull request proposes adding a glossary section to the Klaytn documentation. This glossary will define key terms encountered throughout the documentation, particularly those related to blockchain technology.

Proposed changes

  • Describe your changes to communicate to the maintainers why we should accept this pull request.
  • If it fixes a bug or resolves a feature request, be sure to link to that issue.

Types of changes

Please put an x in the boxes related to your change.

  • Minor Issues and Typos
  • Major Content Contribution
  • Others

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to reach out. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

  • I have read the CONTRIBUTING GUIDELINES
  • I have signed the CLA
  • I have added necessary documentation (if appropriate)
  • Any dependent changes have been merged and published in downstream modules

Related issues

  • Please leave the issue numbers or links related to this PR here.

Further comments

If this is a relatively large content contribution, kick off the discussion by explaining why you would suggest the content contribution, etc...

This pull request proposes adding a glossary section to the Klaytn documentation. This glossary will define key terms encountered throughout the documentation, particularly those related to blockchain technology.
Copy link

github-actions bot commented May 4, 2024

CLA Assistant Lite bot:
Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


I have read the CLA Document and I hereby sign the CLA


You can retrigger this bot by commenting recheck in this Pull Request

@CLAassistant
Copy link

CLAassistant commented May 4, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Collaborator

@scott-klaytn scott-klaytn left a comment

Choose a reason for hiding this comment

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

@ChinonyeRuth Thank you for contribution to Klaytn docs. Two things I'd like to comment:

  1. Please post "I have read the CLA Document and I hereby sign the CLA" in a comment in this PR.
  2. FYI, we have an existing Glossary page under the Learn section. Please move these entries to the page. If you want them to be more contextual, please use the tooltip functionality. If you have any questions, feel free to ping me.

@scott-klaytn
Copy link
Collaborator

Thank you for your contribution! Due to repository migration, we're closing this PR for now. We plan to reopen contributions in the new Kaia docs repo once it's public. We encourage you to resubmit your PR there then.

@github-actions github-actions bot locked and limited conversation to collaborators May 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants