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

180 - Auto Generated User Docs #197

Merged
merged 45 commits into from
Nov 23, 2023
Merged

180 - Auto Generated User Docs #197

merged 45 commits into from
Nov 23, 2023

Conversation

github-actions[bot]
Copy link

Solves #180

@0xmemorygrinder 0xmemorygrinder force-pushed the feature/180-auto-generated-user-docs-staging branch 2 times, most recently from 5979b99 to 7d9d61e Compare November 6, 2023 18:33
@ByFishh ByFishh force-pushed the feature/180-auto-generated-user-docs-staging branch from 8c0d19f to 342f612 Compare November 19, 2023 23:01
@ByFishh ByFishh marked this pull request as ready for review November 19, 2023 23:44
Leon-azerty
Leon-azerty approved these changes Nov 20, 2023
View reviewed changes
Copy link
Contributor

@Leon-azerty Leon-azerty left a comment

Choose a reason for hiding this comment

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

LGFM

EnzoBonato
EnzoBonato approved these changes Nov 20, 2023
View reviewed changes
Copy link
Contributor

@EnzoBonato EnzoBonato left a comment

Choose a reason for hiding this comment

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

👍

0xmemorygrinder
0xmemorygrinder suggested changes Nov 21, 2023
View reviewed changes
Copy link
Contributor

@0xmemorygrinder 0xmemorygrinder left a comment

Choose a reason for hiding this comment

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

The CD pipeline to generate and publish doc is not made yet, please implement this feature before this PR can be merged.

@0xmemorygrinder 0xmemorygrinder force-pushed the dev branch 5 times, most recently from f87bf0b to 7369634 Compare November 22, 2023 23:19
Astrodevs CI and others added 13 commits November 23, 2023 14:52
@0xmemorygrinder
chore: create branch feature/180-auto-generated-user-docs-staging
e8f9dd6
@0xmemorygrinder
chore: create branch feature/180-auto-generated-user-docs/190-expose-…
3c9ab1f 
…rules-doc-with-argument-staging
@EnzoBonato @0xmemorygrinder
feat(solidity/linter): Add new argument in cli
bc11c0e
@ByFishh @0xmemorygrinder
feat(solidity/linter): add rule documentation type
6e41914
@ByFishh @0xmemorygrinder
feat(solidity/linter): remove option for empty vector
394ba78
@EnzoBonato @0xmemorygrinder
feat:(solidity/linter): Add new function to display rules documentation
4943d5a
@ByFishh @0xmemorygrinder
feat(solidity/linter): implement new method in RuleType
a7dcf64
@ByFishh @0xmemorygrinder
feat(solidity/linter): filling RuleDocumentation struct and format
b34dd7a
@EnzoBonato @0xmemorygrinder
feat(solidity/linter): filling RuleDocumentation struct and format
591794f
@ByFishh @0xmemorygrinder
feat(solidity/linter): add new fields for documentation
f1c8e62
@ByFishh @0xmemorygrinder
feat(solidity/linter): print json in cli, add source and test link
81f24db
@EnzoBonato @0xmemorygrinder
feat(solidity/linter): fill example_config in every rule documentation
dc33d7f
@ByFishh @0xmemorygrinder
feat(solidity/linter): add severity to the documentation struct
ba70c54
Leon-azerty and others added 27 commits November 23, 2023 14:52
@Leon-azerty @0xmemorygrinder
feat: can give filepath via argument
4135982
@Leon-azerty @0xmemorygrinder
feat: update script with new structure tree
7f6cfa2
@Leon-azerty @0xmemorygrinder
feat: create main function + readability
77f1647
@Leon-azerty @0xmemorygrinder
refactor: replace if statements by array of functions
933254b
@Leon-azerty @0xmemorygrinder
fix: id undefined
d9aff22
@Leon-azerty @0xmemorygrinder
refactor
0565818
@ByFishh @0xmemorygrinder
feat(solidity/linter): remove removeme
40c485c
@ByFishh @0xmemorygrinder
feat(solidity/linter): remove generated file
0e8ac10
@ByFishh @0xmemorygrinder
feat(solidity/linter): edit retype config, display message when optio…
b3859ef 
…n and examples are empty
@ByFishh @0xmemorygrinder
feat(solidity/linter): error message is now in english
9b3aa66
@ByFishh @0xmemorygrinder
feat(solidity/linter): fix rebase issue
8e93b1f
@ByFishh @0xmemorygrinder
feat(solidity/linter): remove additional print when using -d in cli
b3e6560
@ByFishh @0xmemorygrinder
feat(solidity/linter):default homepage
278ebe6
@ByFishh @0xmemorygrinder
feat(solidity/linter): remove bold on description
2c5fd10
@ByFishh @0xmemorygrinder
feat(solidity/linter): format examples and code
aa98813
@ByFishh @0xmemorygrinder
feat(solidity/linter): remove removeme
fc6d88e
@ByFishh @0xmemorygrinder
feat(docs): github action to deploy documentation
cf83ac0
@ByFishh @0xmemorygrinder
feat(docs): workflow_dispatch
e05209a
@ByFishh @0xmemorygrinder
feat(docs): github action trigger event
c5dac37
@ByFishh @0xmemorygrinder
feat(docs): remove useless function parameters
674a6b7
@ByFishh @0xmemorygrinder
fix(docs): change trigger with good branch
f9532fc
@ByFishh @0xmemorygrinder
fix(docs): action change doc folder path
9e97a5b
@ByFishh @0xmemorygrinder
fix(docs): update checkout with good ref
51af497
@ByFishh @0xmemorygrinder
fix(docs): cd in good folder (starting from root each step)
cb7a6eb
@ByFishh @0xmemorygrinder
fix(docs): good path to retype config file
08f74f7
@ByFishh @0xmemorygrinder
fix(docs): add arg when calling createMarkdownFilesFromJsonArray.js
3305982
@ByFishh @0xmemorygrinder
feat(docs): change ref to main
1d98f48
@0xmemorygrinder 0xmemorygrinder force-pushed the feature/180-auto-generated-user-docs-staging branch from da0ac9f to 1d98f48 Compare November 23, 2023 19:52
@ByFishh ByFishh merged commit c66021b into dev Nov 23, 2023
14 checks passed
@0xmemorygrinder 0xmemorygrinder deleted the feature/180-auto-generated-user-docs-staging branch November 26, 2023 19:01
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@Leon-azerty Leon-azerty Leon-azerty approved these changes

@EnzoBonato EnzoBonato EnzoBonato approved these changes

@0xmemorygrinder 0xmemorygrinder 0xmemorygrinder approved these changes

Assignees
No one assigned
Labels
None yet
Projects
Project Management
Status: No status
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@0xmemorygrinder @EnzoBonato @Leon-azerty @ByFishh