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

docs: improve global structure #1023

Merged
merged 13 commits into from
Apr 14, 2024
Merged

docs: improve global structure #1023

merged 13 commits into from
Apr 14, 2024

Conversation

lars-reimann
Copy link
Member

@lars-reimann lars-reimann commented Apr 12, 2024

Closes #1029

Summary of Changes

  • Separate explanation of the pipeline and the stub language.
  • Explain segments after comments. They are not needed to get started.
  • Improve home page.
  • Improve installation guide.
  • Improve home page of language reference.
  • Improve documentation of packages.

Copy link

github-actions bot commented Apr 12, 2024

🦙 MegaLinter status: ❌ ERROR

Descriptor Linter Files Fixed Errors Elapsed time
✅ CSS stylelint 1 0 0 1.51s
✅ JAVASCRIPT eslint 1 0 0 7.14s
✅ JAVASCRIPT prettier 1 0 0 0.61s
✅ JSON eslint-plugin-jsonc 2 0 0 1.4s
✅ JSON jsonlint 2 0 0.28s
✅ JSON npm-package-json-lint yes no 0.82s
✅ JSON prettier 3 0 0 0.88s
✅ JSON v8r 2 0 7.56s
❌ MARKDOWN markdown-link-check 89 1 5.71s
✅ PYTHON black 2 0 0 1.01s
✅ PYTHON mypy 2 0 2.21s
✅ PYTHON ruff 2 0 0 0.19s
✅ REPOSITORY git_diff yes no 0.27s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by OX Security

Copy link

codecov bot commented Apr 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (8be49c5) to head (409b8e3).
Report is 122 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #1023   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           99        99           
  Lines        19051     19051           
  Branches      3902      3902           
=========================================
  Hits         19051     19051           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lars-reimann lars-reimann force-pushed the swap-documentation-sections branch 3 times, most recently from 7234136 to a316e32 Compare April 12, 2024 20:14
@lars-reimann lars-reimann marked this pull request as ready for review April 12, 2024 20:25
@lars-reimann lars-reimann marked this pull request as draft April 12, 2024 20:25
@lars-reimann lars-reimann changed the title docs: explain segments last docs: improve global structure Apr 14, 2024
@lars-reimann lars-reimann marked this pull request as ready for review April 14, 2024 15:07
@lars-reimann lars-reimann merged commit def5279 into main Apr 14, 2024
8 of 9 checks passed
@lars-reimann lars-reimann deleted the swap-documentation-sections branch April 14, 2024 15:07
@lars-reimann
Copy link
Member Author

🎉 This PR is included in version 0.12.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@lars-reimann lars-reimann added the released Included in a release label Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Included in a release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Restructure language documentation
1 participant