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

[Documentation] Add style guide to docusaurus #329

Closed
wants to merge 3 commits into from

Conversation

h5law
Copy link
Contributor

@h5law h5law commented Jan 17, 2024

Summary

Human Summary

  • Adds style guide documentation
  • Adds tooling information around
    • imports
    • formatting
    • line length
  • And configuration information

AI Summary

Summary generated by Reviewpad on 17 Jan 24 18:02 UTC

This pull request includes the following changes:

  1. In the .github/workflows/main-build.yml file, the step "Install CI dependencies" was renamed to "Install dependencies", and the corresponding make install_ci_deps command was replaced with make install_deps.
  2. In the same file, the step "Authenticate to Google Cloud" was updated with the correct indentation and the secret value was enclosed in double quotes.
  3. In the Makefile, the target install_ci_deps was renamed to install_deps, and the target description was updated accordingly.
  4. Two new files were added: docusaurus/docs/contributing/style-guide.json and docusaurus/docs/contributing/style-guide.md.

Issue

Fixes N/A

Screenshot 2024-01-17 at 17 59 04

Type of change

Select one or more:

  • New feature, functionality or library
  • Bug fix
  • Code health or cleanup
  • Documentation
  • Other (specify)

Testing

  • Run all unit tests: make go_develop_and_test
  • Run E2E tests locally: make test_e2e
  • Run E2E tests on DevNet: Add the devnet-test-e2e label to the PR. This is VERY expensive, only do it after all the reviews are complete.

Sanity Checklist

  • I have tested my changes using the available tooling
  • I have performed a self-review of my own code
  • I have commented my code, updated documentation and left TODOs throughout the codebase

@h5law h5law self-assigned this Jan 17, 2024
@h5law h5law added the documentation Improvements or additions to documentation label Jan 17, 2024
@h5law h5law added this to the Shannon TestNet milestone Jan 17, 2024
@Olshansk
Copy link
Member

@h5law Should we move this one to a draft state if it's not under active review/development?

@Olshansk Olshansk marked this pull request as draft February 1, 2024 18:33
@h5law
Copy link
Contributor Author

h5law commented Mar 12, 2024

Draft, moved into iteration 14 «Developer Experience», probably good to pair this with #319

@Olshansk
Copy link
Member

Olshansk commented Apr 8, 2024

Will reopen when the time is right.

@Olshansk Olshansk closed this Apr 8, 2024
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
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants