feature/GithubPages #26
Conversation
Reviewer's Guide by SourceryThis pull request implements a new feature for GitHub Pages. It adds several new files and configurations to set up documentation using Sphinx. The main changes include adding new HTML, CSS, and JavaScript files for the documentation site, as well as configuration files for Sphinx. The PR also removes a GitHub Actions workflow file related to GitHub Pages. File-Level Changes
Tips
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @dan5e3s6ares - I've reviewed your changes - here's some feedback:
Overall Comments:
- Consider generating documentation files as part of a build process rather than committing them directly. This would keep the repository cleaner and easier to maintain.
- The addition of documentation is great, but try to minimize the number of generated files in the repository. Consider using a .gitignore file to exclude build artifacts.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟡 Documentation: 5 issues found
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.
| @@ -0,0 +1,85 @@ | |||
| # Scenarios | |||
|
|
|||
| With ARMA you can create scenarios by adding your own uses cases to OpenAPI paths. | |||
There was a problem hiding this comment.
issue (documentation): Typo: 'uses cases' should be 'use cases'
| Its response method takes a Request object and a url_data dictionary as input.<p> | ||
| It returns a JSON response with the message "from SimpleFunction" and a status code of 201. |
There was a problem hiding this comment.
suggestion (documentation): Remove unnecessary HTML tags
The '
' tags are not needed in this context and should be removed for consistency.
| Its response method also takes a Request object and a url_data dictionary.<p> | ||
| It retrieves the JSON payload from the request body using await request.json().<p> | ||
| It checks the value of payload["payload_id"]:<p> | ||
| If it's "123", it uses the jsf library to generate fake data based on the schema specified in url_data['responses']["200"]['schema'] and returns a JSON response with the generated data and a status code of 200.<p> | ||
| If it's not "123", it generates fake data based on the schema in url_data['responses']["405"]['schema'] and returns a JSON response with the generated data and a status code of 405. |
There was a problem hiding this comment.
suggestion (documentation): Remove unnecessary HTML tags
The '
' tags are not needed in this context and should be removed for consistency.
| ```json | ||
| { | ||
| "mock_api_swaggerUrl": "https//www.yourapi.com/doc/swagger.json", | ||
| "mock_api_swaggerYamlUrl": "https//www.yourapi.com/doc/swagger.ymal", |
There was a problem hiding this comment.
issue (documentation): Typo in JSON example: 'swagger.ymal' should be 'swagger.yaml'
| 2. Fork the project | ||
| 3. Create your feature branch (`git checkout -b feat/amazing_feature`) | ||
| 4. Commit your changes (`git commit -m 'feat: add amazing_feature'`) {% if cookiecutter.use_conventional_commits == 'y' -%} | ||
| {{cookiecutter.project_name}} uses [conventional commits](https://www.conventionalcommits.org), so please follow the specification in your commit messages.{% endif %} |
There was a problem hiding this comment.
issue (documentation): Replace placeholder with actual project name
The placeholder '{{cookiecutter.project_name}}' needs to be replaced with the actual name of the project.
| }; | ||
|
|
||
| var c = "[^aeiou]"; // consonant | ||
| var v = "[aeiouy]"; // vowel |
There was a problem hiding this comment.
issue (code-quality): Use const or let instead of var. (avoid-using-var)
Explanation
`const` is preferred as it ensures you cannot reassign references (which can lead to buggy and confusing code). `let` may be used if you need to reassign references - it's preferred to `var` because it is block- rather than function-scoped.From the Airbnb JavaScript Style Guide
|
|
||
| var c = "[^aeiou]"; // consonant | ||
| var v = "[aeiouy]"; // vowel | ||
| var C = c + "[^aeiouy]*"; // consonant sequence |
There was a problem hiding this comment.
issue (code-quality): Use const or let instead of var. (avoid-using-var)
Explanation
`const` is preferred as it ensures you cannot reassign references (which can lead to buggy and confusing code). `let` may be used if you need to reassign references - it's preferred to `var` because it is block- rather than function-scoped.From the Airbnb JavaScript Style Guide
| var c = "[^aeiou]"; // consonant | ||
| var v = "[aeiouy]"; // vowel | ||
| var C = c + "[^aeiouy]*"; // consonant sequence | ||
| var V = v + "[aeiou]*"; // vowel sequence |
There was a problem hiding this comment.
issue (code-quality): Use const or let instead of var. (avoid-using-var)
Explanation
`const` is preferred as it ensures you cannot reassign references (which can lead to buggy and confusing code). `let` may be used if you need to reassign references - it's preferred to `var` because it is block- rather than function-scoped.From the Airbnb JavaScript Style Guide
| var C = c + "[^aeiouy]*"; // consonant sequence | ||
| var V = v + "[aeiou]*"; // vowel sequence | ||
|
|
||
| var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 |
There was a problem hiding this comment.
issue (code-quality): Use const or let instead of var. (avoid-using-var)
Explanation
`const` is preferred as it ensures you cannot reassign references (which can lead to buggy and confusing code). `let` may be used if you need to reassign references - it's preferred to `var` because it is block- rather than function-scoped.From the Airbnb JavaScript Style Guide
| var V = v + "[aeiou]*"; // vowel sequence | ||
|
|
||
| var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 | ||
| var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 |
There was a problem hiding this comment.
issue (code-quality): Use const or let instead of var. (avoid-using-var)
Explanation
`const` is preferred as it ensures you cannot reassign references (which can lead to buggy and confusing code). `let` may be used if you need to reassign references - it's preferred to `var` because it is block- rather than function-scoped.From the Airbnb JavaScript Style Guide
Update git_pages
Please check the type of change your PR introduces:
Summary by Sourcery
Add a new feature to generate a static site for ARMA documentation using Sphinx, including stylesheets, JavaScript utilities, and HTML files. The documentation covers various topics such as usage scenarios, contributing guidelines, and a code of conduct.
New Features:
Documentation: