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

Rework documentation #1

Open
romanzaycev opened this issue Oct 11, 2023 · 1 comment
Open

Rework documentation #1

romanzaycev opened this issue Oct 11, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hack-ton-berfest hacktoberfest

Comments

@romanzaycev
Copy link
Member

Currently, the documentation for the classes of interop component is not very easy to learn.

We need to:

  • move Markdown files of documentation to a separate docs/ directory;
  • separate the description of each class into a separate Markdown file;
  • make a link to the documentation section from the root README.
@romanzaycev romanzaycev added enhancement New feature or request good first issue Good for newcomers hacktoberfest hack-ton-berfest documentation Improvements or additions to documentation labels Oct 11, 2023
@jchansen925
Copy link

@romanzaycev

Please assign this to me. I can begin this once the Ton issue is complete.

Thanks,

John

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers hack-ton-berfest hacktoberfest
Projects
None yet
Development

No branches or pull requests

2 participants