Add Documentation for Global Variables
Open
Nobody has claimed this yet.
website doc page
- Dominant language
- SCSS
- Stars
- 10
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
Description:
The current documentation does not explain how Global Variables work in ScanAPI. This can create confusion for new users and limit the full use of the feature.
This issue aims to:
- Add a dedicated section about Global Variables to the official documentation.
- Provide practical usage examples in different contexts.
- Clarify the differences between global and local variables, including best practices.
Reference: Implemented in #265
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing official documentation and the implementation referenced in issue #265. Done means the documentation has a dedicated Global Variables section with practical examples, a global-versus-local comparison, and best practices.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jekyll
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100