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

Builtin docs linter & utilities #108

Closed

Conversation

marcinjangrzybowski
Copy link

@marcinjangrzybowski marcinjangrzybowski commented Feb 20, 2024

PR checklist:

  • Test coverage for the proposed changes
  • PR description contains example output from repl interaction or a snippet from unit test output
  • Any changes that could be relevant to users have been recorded in the changelog

Additionally, please justify why you should or should not do the following:

  • Confirm replay/back compat
  • Benchmark regressions
  • (For Kadena engineers) Run integration-tests against a Chainweb built with this version of Pact

@marcinjangrzybowski
Copy link
Author

For now I prepared required glue code, and some basic example linting rules, to be able quickly implement actual rules once convention for our docs is decided by the team.
I am set up to meet with linda to learn what I can begin with.

Example markdown files with documentation where directly exported from notion documents.

@marcinjangrzybowski
Copy link
Author

based on scraping of older docs, and results of linting of current md files,
it can also generate summary of builtin docs state:
docs-utils/docs-utils/generated/summary.md

@marcinjangrzybowski
Copy link
Author

Also, I expect some of this code to be droped, once I talk to jose and got his thoughts on what should be the focus here.

@rsoeldner
Copy link
Member

closing as core builtin docs are captured in #122

@rsoeldner rsoeldner closed this May 15, 2024
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