Updated links to developer.palisadoes.org#384
Conversation
palisadoes
added
the
ignore-sensitive-files-pr
WalkthroughThe pull request updates guideline links from GitHub paths to developer documentation URLs across multiple files, adds two new documentation pages for configuration and contributing guidelines, reformats existing documentation files for consistency, removes an outdated configuration documentation file, and restructures the sidebar navigation with explicit hierarchical categories and collapsible behavior. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Our Pull Request Approval ProcessWe have these basic policies to make the approval process smoother for our volunteer team. Testing Your CodePlease make sure your code passes all tests. Our test code coverage system will fail if either of these two conditions occur:
The process helps maintain the overall reliability of the code base and is a prerequisite for getting your PR approved. Assigned reviewers regularly review the PR queue and tend to focus on PRs that are passing. ReviewersWhen your PR has been assigned reviewers contact them to get your code reviewed and approved via:
Reviewing Your CodeYour reviewer(s) will have the following roles:
🎯 Contacting the person who assigned the mentors is not advised unless they make a request. Do not @ the person who did the assignment otherwise. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #384 +/- ##
===========================================
+ Coverage 82.53% 85.94% +3.40%
===========================================
Files 105 128 +23
Lines 6961 10797 +3836
Branches 0 751 +751
===========================================
+ Hits 5745 9279 +3534
- Misses 1216 1503 +287
- Partials 0 15 +15 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
🧹 Nitpick comments (3)
docs/docs/getting-started/troubleshooting.md (1)
21-72: Consider minor style improvements.Two optional style improvements per LanguageTool (these are low-priority):
- Lines ~25: Three successive sentences begin with "The" — consider rewording for variety.
- Line ~27: "The poller will need to be running prior to testing" — consider "before testing" for conciseness.
These are minor style enhancements and not blockers.
docs/docs/getting-started/architecture.md (1)
63-75: Hyphenate compound modifier.Line 66 should use a hyphen for the compound adjective:
- The ingester processes these and deduplicates the information before adding it to the database. This information is often needed before processing the interface information to help cross referencing. + The ingester processes these and deduplicates the information before adding it to the database. This information is often needed before processing the interface information to help cross-referencing.docs/docs/getting-started/configuration.md (1)
35-109: Add language identifier to code block.The YAML code block should specify
yamlas the language identifier for proper syntax highlighting.Apply this diff:
-```yaml +```yamlNote: This appears to already be correct in the provided code. The static analysis tool may have flagged an earlier version.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (17)
CODE_OF_CONDUCT.md(1 hunks)CONTRIBUTING.md(1 hunks)ISSUE_GUIDELINES.md(1 hunks)PR_GUIDELINES.md(1 hunks)docs/docs/configuration.md(0 hunks)docs/docs/getting-started/architecture.md(4 hunks)docs/docs/getting-started/cli.md(8 hunks)docs/docs/getting-started/community.md(1 hunks)docs/docs/getting-started/configuration.md(1 hunks)docs/docs/getting-started/contributing.md(1 hunks)docs/docs/getting-started/installation.md(8 hunks)docs/docs/getting-started/introduction.md(4 hunks)docs/docs/getting-started/operation.md(2 hunks)docs/docs/getting-started/testing.md(9 hunks)docs/docs/getting-started/troubleshooting.md(5 hunks)docs/docs/getting-started/webserver.md(2 hunks)docs/sidebars.ts(1 hunks)
💤 Files with no reviewable changes (1)
- docs/docs/configuration.md
🧰 Additional context used
🧠 Learnings (16)
📓 Common learnings
Learnt from: Abhi-MS
Repo: PalisadoesFoundation/switchmap-ng PR: 337
File: docs/docs/frontend/components/DevicesOverview.md:15-15
Timestamp: 2025-09-04T18:48:21.426Z
Learning: The documentation files in docs/docs/frontend/ contain autogenerated GitHub links that cannot be manually edited, as they are created by the documentation generation tooling and would be overwritten.
📚 Learning: 2025-09-05T23:17:28.772Z
Learnt from: Abhi-MS
Repo: PalisadoesFoundation/switchmap-ng PR: 337
File: frontend/src/app/history/page.tsx:20-41
Timestamp: 2025-09-05T23:17:28.772Z
Learning: In the switchmap-ng project, each poll creates a new device/event record, so the zones->devices GraphQL query effectively returns all historical points for devices, not just current snapshots. This enables time-series visualization without needing a separate historical data source.
Applied to files:
docs/docs/getting-started/introduction.mddocs/docs/getting-started/cli.md
📚 Learning: 2025-11-16T00:24:21.467Z
Learnt from: palisadoes-bot
Repo: PalisadoesFoundation/switchmap-ng PR: 0
File: :0-0
Timestamp: 2025-11-16T00:24:21.467Z
Learning: In the switchmap-ng repository, first-time contributors cannot use auto-assignment features. They must explicitly ask to be assigned by a maintainer instead.
Applied to files:
docs/docs/getting-started/introduction.md
📚 Learning: 2025-09-04T20:04:37.212Z
Learnt from: Abhi-MS
Repo: PalisadoesFoundation/switchmap-ng PR: 337
File: docs/docs/frontend/types/graphql/GetZoneDevices.md:59-64
Timestamp: 2025-09-04T20:04:37.212Z
Learning: Documentation files in docs/docs/frontend/ are autogenerated by TypeDoc from TypeScript source code and should not be manually edited. Changes should be made to the source TypeScript files instead.
Applied to files:
docs/docs/getting-started/architecture.mddocs/docs/getting-started/installation.mddocs/sidebars.ts
📚 Learning: 2025-08-10T14:53:39.577Z
Learnt from: abbi4code
Repo: PalisadoesFoundation/switchmap-ng PR: 328
File: switchmap/poller/snmp/mib/generic/mib_if.py:270-273
Timestamp: 2025-08-10T14:53:39.577Z
Learning: In the switchmap-ng SNMP poller migration from easysnmp to pysnmp, the pysnmp library returns bytes for OctetString values in SNMP responses for OIDs like ifDescr, ifAlias, and ifName in the IF-MIB module. The team prefers to complete the async migration first before addressing potential edge cases in string decoding.
Applied to files:
docs/docs/getting-started/architecture.md
📚 Learning: 2025-08-31T13:33:52.738Z
Learnt from: abbi4code
Repo: PalisadoesFoundation/switchmap-ng PR: 334
File: switchmap/poller/async_poll.py:146-149
Timestamp: 2025-08-31T13:33:52.738Z
Learning: In switchmap-ng async polling, the data structure passed to udevice.Device() comes from async_snmp_info.Query.everything() which initializes it as defaultdict(lambda: defaultdict(dict)) and explicitly sets the "misc" key. This means accessing data["misc"]["zone"] is safe without defensive programming like setdefault().
Applied to files:
docs/docs/getting-started/architecture.md
📚 Learning: 2025-10-08T18:20:01.491Z
Learnt from: Abhi-MS
Repo: PalisadoesFoundation/switchmap-ng PR: 349
File: docs/docs/frontend/utils/deviceUtils.md:26-28
Timestamp: 2025-10-08T18:20:01.491Z
Learning: The documentation files in docs/docs/frontend/ are autogenerated by documentation tooling and cannot be manually edited. Any issues with these files (including markdown formatting) must be fixed in the documentation generation tool or its configuration, not in the generated files directly.
Applied to files:
docs/docs/getting-started/installation.mddocs/docs/getting-started/contributing.md
📚 Learning: 2025-10-22T13:05:09.846Z
Learnt from: abbi4code
Repo: PalisadoesFoundation/switchmap-ng PR: 360
File: scripts/setup.sh:148-156
Timestamp: 2025-10-22T13:05:09.846Z
Learning: The scripts/setup.sh script in the Switchmap-NG repository is intended for development purposes only, not production use, so hardcoded credentials and Docker environment variables for MySQL are acceptable.
Applied to files:
docs/docs/getting-started/installation.mddocs/docs/getting-started/testing.md
📚 Learning: 2025-10-23T12:43:52.214Z
Learnt from: abbi4code
Repo: PalisadoesFoundation/switchmap-ng PR: 360
File: tests/switchmap_/poller/snmp/mib/cisco/test_mib_ciscoprocess.py:0-0
Timestamp: 2025-10-23T12:43:52.214Z
Learning: In the switchmap-ng repository, test files include shebang lines (#!/usr/bin/env python3) to support direct execution of individual test files. Many test files have executable permissions. This is an intentional project design pattern.
Applied to files:
docs/docs/getting-started/installation.mddocs/docs/getting-started/troubleshooting.mddocs/docs/getting-started/cli.mddocs/docs/getting-started/testing.md
📚 Learning: 2025-09-04T18:48:07.835Z
Learnt from: Abhi-MS
Repo: PalisadoesFoundation/switchmap-ng PR: 337
File: docs/docs/frontend/components/ConnectionDetails.md:15-15
Timestamp: 2025-09-04T18:48:07.835Z
Learning: The documentation files in docs/docs/frontend/ are autogenerated and should not be manually edited, as changes would be overwritten by the documentation generation process.
Applied to files:
docs/docs/getting-started/installation.md
📚 Learning: 2025-03-15T07:05:46.277Z
Learnt from: Ayobami0
Repo: PalisadoesFoundation/switchmap-ng PR: 302
File: tests/switchmap_/server/api/routes/test_graphql.py:15-55
Timestamp: 2025-03-15T07:05:46.277Z
Learning: In the switchmap-ng project, test files follow a specific convention for directory path construction, using nested calls to os.path.abspath and os.path.join with the number of nesting levels corresponding to the depth of the file in the directory structure. This pattern is deliberately complex to ensure tests work correctly regardless of how the package is installed.
Applied to files:
docs/docs/getting-started/installation.mddocs/docs/getting-started/testing.md
📚 Learning: 2025-08-09T22:25:34.114Z
Learnt from: abbi4code
Repo: PalisadoesFoundation/switchmap-ng PR: 328
File: switchmap/poller/snmp/async_snmp_manager.py:160-160
Timestamp: 2025-08-09T22:25:34.114Z
Learning: In the switchmap-ng SNMP poller implementation (async_snmp_manager.py), the semaphore concurrency limit for async SNMP requests should be hardcoded to 10. Testing has shown that most SNMP devices can handle 10 concurrent requests without getting overwhelmed, providing better performance than a lower limit while maintaining stability.
Applied to files:
docs/docs/getting-started/troubleshooting.mddocs/docs/getting-started/testing.md
📚 Learning: 2025-08-24T14:56:45.197Z
Learnt from: abbi4code
Repo: PalisadoesFoundation/switchmap-ng PR: 334
File: switchmap/poller/snmp/async_snmp_info.py:0-0
Timestamp: 2025-08-24T14:56:45.197Z
Learning: In the switchmap-ng project, when handling errors in async SNMP operations, the preference is to use warning logs (log.log2warning) instead of exception logs (log.log2exception) for better error handling and cleaner logging output.
Applied to files:
docs/docs/getting-started/troubleshooting.md
📚 Learning: 2025-08-09T22:52:35.889Z
Learnt from: abbi4code
Repo: PalisadoesFoundation/switchmap-ng PR: 328
File: requirements.txt:17-19
Timestamp: 2025-08-09T22:52:35.889Z
Learning: In the switchmap-ng project, pysnmp 6.2.6 is deliberately chosen over 7.x due to: PEP 8 refactoring breaking method names (getCmd → get_cmd), removal of asyncore-based sync API, pyasn1 0.6.1+ dropping pyasn1.compat.octets, breaking changes in MIB instrumentation API, potential asyncio.hlapi import path changes, and proven production stability of 6.2.6. The team is considering future migration to gufo_snmp (a Go-based SNMP library) as an alternative.
Applied to files:
docs/docs/getting-started/testing.md
📚 Learning: 2025-01-19T11:52:07.649Z
Learnt from: prayanshchh
Repo: PalisadoesFoundation/switchmap-ng PR: 274
File: switchmap/server/db/ingest/update/zone.py:261-286
Timestamp: 2025-01-19T11:52:07.649Z
Learning: In the switchmap-ng project, database tests are run with DNS lookups disabled (dns=False) to avoid external dependencies and ensure consistent test execution times.
Applied to files:
docs/docs/getting-started/testing.md
📚 Learning: 2025-08-10T14:39:18.768Z
Learnt from: abbi4code
Repo: PalisadoesFoundation/switchmap-ng PR: 328
File: snmp_test.py:68-73
Timestamp: 2025-08-10T14:39:18.768Z
Learning: For test scripts and non-production code in the switchmap-ng repository, prioritize simplicity over robustness. Simple timing with `time.time()` is acceptable for test files, and additional complexity like timeouts and monotonic timers should not be suggested unless specifically needed for the test's purpose.
Applied to files:
docs/docs/getting-started/testing.md
🪛 LanguageTool
docs/docs/getting-started/introduction.md
[grammar] ~11-~11: Use a hyphen to join words.
Context: ...orts and tabulates the status of network connected devices. The information repor...
(QB_NEW_EN_HYPHEN)
[style] ~42-~42: The preposition ‘amongst’ is correct, but some people think that it is old-fashioned or literary. A more frequently used alternative is the preposition “among”.
Context: ...to three roles which can be distributed amongst one or more systems. 1. *Dashboard...
(AMONGST)
[grammar] ~48-~48: Use a hyphen to join words.
Context: ...ler, Dashboard and a backend MySQL compatible RDBMS database. We are alway...
(QB_NEW_EN_HYPHEN)
[style] ~64-~64: Consider using a more formal verb to strengthen your wording.
Context: ...able Clicking on any of the links will give interface information. 
[grammar] ~79-~79: Ensure spelling is correct
Context: ...gston, Jamaica) 2. The University of Techology, IEEE Student Branch. (Kingston, Jam...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
docs/docs/getting-started/architecture.md
[grammar] ~66-~66: Use a hyphen to join words.
Context: ... the interface information to help cross referencing. 1. All IP address, MAC ...
(QB_NEW_EN_HYPHEN)
docs/docs/getting-started/troubleshooting.md
[style] ~25-~25: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...in/switchmap_dashboard --start ``` ### Start the Poller Interactively The poller wi...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~27-~27: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...ely The poller will need to be running prior to testing. ```bash (venv) $ bin/switchma...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
CONTRIBUTING.md
[uncategorized] ~5-~5: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ibuting to open source, please read the Open Source Guides on [How to Contribute to Open So...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~51-~51: The official name of this software platform is spelled with a capital “H”.
Context: ... push the changes to the forked repo on github using: git push origin <branch_name>....
(GITHUB)
docs/docs/getting-started/configuration.md
[style] ~29-~29: Consider using the more formal “until”.
Context: ...ameter sets in the snmp_group section till successful. NOTE: If a default val...
(TILL)
[grammar] ~136-~136: Ensure spelling is correct
Context: ...tchmap username has write access to it. Defaultsto the log/subdirectory of `system_direc...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~154-~154: Ensure spelling is correct
Context: ...e SSL capabilities of the pre-installed webserver of your choice to encrypt data sent ove...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~156-~156: Ensure spelling is correct
Context: ...simple authentication username that the dashbord server uses. Defaults to None. ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~160-~160: Ensure spelling is correct
Context: ...e SSL capabilities of the pre-installed webserver of your choice to encrypt data sent ove...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~181-~181: Ensure spelling is correct
Context: ...e SSL capabilities of the pre-installed webserver of your choice to encrypt data sent ove...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~183-~183: Ensure spelling is correct
Context: ...simple authentication username that the dashbord server uses. Defaults to None. ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~211-~211: Ensure spelling is correct
Context: ...e SSL capabilities of the pre-installed webserver of your choice to encrypt data sent ove...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
docs/docs/getting-started/testing.md
[grammar] ~121-~121: Use a hyphen to join words.
Context: ... able to make GraphQL queries in an easy to use interactive web page. 1. Enter ...
(QB_NEW_EN_HYPHEN)
[grammar] ~124-~124: Use a hyphen to join words.
Context: ... page. 1. Enter your query in the left hand panel 2. Press the Play button 3...
(QB_NEW_EN_HYPHEN)
🪛 markdownlint-cli2 (0.18.1)
docs/docs/getting-started/introduction.md
40-40: Dollar signs used before commands without showing output
(MD014, commands-show-output)
46-46: Dollar signs used before commands without showing output
(MD014, commands-show-output)
60-60: Dollar signs used before commands without showing output
(MD014, commands-show-output)
66-66: Dollar signs used before commands without showing output
(MD014, commands-show-output)
80-80: Dollar signs used before commands without showing output
(MD014, commands-show-output)
docs/docs/getting-started/installation.md
356-356: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
362-362: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
368-368: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
docs/docs/getting-started/configuration.md
35-35: Code block style
Expected: indented; Actual: fenced
(MD046, code-block-style)
docs/docs/getting-started/webserver.md
49-49: Dollar signs used before commands without showing output
(MD014, commands-show-output)
docs/docs/getting-started/testing.md
34-34: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
41-41: Dollar signs used before commands without showing output
(MD014, commands-show-output)
45-45: Dollar signs used before commands without showing output
(MD014, commands-show-output)
48-48: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
54-54: Dollar signs used before commands without showing output
(MD014, commands-show-output)
178-178: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Test Application
🔇 Additional comments (10)
ISSUE_GUIDELINES.md (1)
3-3: ✓ LGTMLink update to developer.palisadoes.org is correct and consistent with the PR objective.
CODE_OF_CONDUCT.md (1)
3-3: ✓ LGTMLink update to developer.palisadoes.org is correct and consistent with the PR objective.
PR_GUIDELINES.md (1)
3-3: ✓ LGTMLink update to developer.palisadoes.org is correct and consistent with the PR objective.
docs/docs/getting-started/contributing.md (1)
1-7: ✓ LGTMNew contributing documentation page is well-structured with proper front matter (id, title, sidebar_position) and a link to the centralized Palisadoes contributing guidelines. Aligns with PR objective.
docs/docs/getting-started/troubleshooting.md (1)
1-6: ✓ LGTMFront matter updates and code fence normalization are consistent with the broader documentation restructuring.
docs/docs/getting-started/installation.md (1)
1-5: ✓ LGTMFront matter additions (id, sidebar_position) are consistent with the documentation restructuring across getting-started pages.
docs/docs/getting-started/operation.md (1)
1-6: ✓ LGTMFront matter additions (id, sidebar_position) and code fence normalization align with the broader documentation restructuring across getting-started pages.
docs/docs/getting-started/architecture.md (1)
1-5: ✓ LGTMFront matter additions (id, sidebar_position) align with the broader documentation restructuring across getting-started pages.
docs/docs/getting-started/community.md (1)
9-11: LGTM! Community link updated successfully.The update from Slack to Forums with the new Palisadoes Foundation Forum link aligns with the PR objectives to consolidate community resources.
CONTRIBUTING.md (1)
26-26: Based on my web search, I found critical information about the Switchmap-NG repository's documentation structure:Key findings:
- Switchmap-NG's testing documentation is hosted externally at https://docs.switchmap-ng.io/docs/testing/ and https://switchmap-ng.readthedocs.io/en/latest/testing.html
- There is no local
docs/docs/docs/developer-resources/testing.mdpath (the triple "docs" pattern is not a valid documentation structure)The review comment correctly identified that the path contains an unusual triple "docs" directory pattern. The path in CONTRIBUTING.md should be corrected to point to the actual external documentation URL or the correct local path if one exists.
The path
docs/docs/docs/developer-resources/testing.mdis incorrect and contains redundant "docs" directories.The testing guide for Switchmap-NG is hosted at https://docs.switchmap-ng.io/docs/testing/ (or via ReadTheDocs at https://switchmap-ng.readthedocs.io/en/latest/testing.html). Update CONTRIBUTING.md line 26 (and line 45 if applicable) to link to the correct external documentation URL instead of the invalid local path with triple "docs" directories.
⛔ Skipped due to learnings
Learnt from: Ayobami0 Repo: PalisadoesFoundation/switchmap-ng PR: 302 File: tests/switchmap_/server/api/routes/test_graphql.py:15-55 Timestamp: 2025-03-15T07:05:46.277Z Learning: In the switchmap-ng project, test files follow a specific convention for directory path construction, using nested calls to os.path.abspath and os.path.join with the number of nesting levels corresponding to the depth of the file in the directory structure. This pattern is deliberately complex to ensure tests work correctly regardless of how the package is installed.
|
|
||
| 1. After making changes you can add them to git locally using `git add <file_name>`(to add changes only in a particular file) or `git add .` (to add all changes). | ||
| 1. After adding the changes you need to commit them using `git commit -m '<commit message>'`(look at the commit guidelines below for commit messages). | ||
| 1. Once you have successfully commited your changes, you need to push the changes to the forked repo on github using: `git push origin <branch_name>`.(Here branch name must be name of the branch you want to push the changes to.) |
There was a problem hiding this comment.
Use proper capitalization for "GitHub".
The official name uses a capital "H".
Apply this diff:
-1. Once you have successfully commited your changes, you need to push the changes to the forked repo on github using: `git push origin <branch_name>`.(Here branch name must be name of the branch you want to push the changes to.)
+1. Once you have successfully commited your changes, you need to push the changes to the forked repo on GitHub using: `git push origin <branch_name>`.(Here branch name must be name of the branch you want to push the changes to.)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 1. Once you have successfully commited your changes, you need to push the changes to the forked repo on github using: `git push origin <branch_name>`.(Here branch name must be name of the branch you want to push the changes to.) | |
| 1. Once you have successfully commited your changes, you need to push the changes to the forked repo on GitHub using: `git push origin <branch_name>`.(Here branch name must be name of the branch you want to push the changes to.) |
🧰 Tools
🪛 LanguageTool
[uncategorized] ~51-~51: The official name of this software platform is spelled with a capital “H”.
Context: ... push the changes to the forked repo on github using: git push origin <branch_name>....
(GITHUB)
🤖 Prompt for AI Agents
In CONTRIBUTING.md around line 51, the word "github" is not using the official
capitalization; update the text to use "GitHub" (capital G and H) in the
sentence describing how to push to the forked repo so it reads "...push the
changes to the forked repo on GitHub using: `git push origin <branch_name>`."
| snmp_groups: | ||
|
|
||
| - group_name: V2 | ||
| snmp_version: 2 | ||
| snmp_secname: | ||
| snmp_community: YOUR_SNMP_COMMUNITY | ||
| snmp_port: 161 | ||
| snmp_authprotocol: | ||
| snmp_authpassword: | ||
| snmp_privprotocol: | ||
| snmp_privpassword: | ||
| enabled: True |
There was a problem hiding this comment.
Remove duplicate snmp_groups key to prevent YAML parsing errors.
The snmp_groups key appears twice (lines 76-87 and 89-108), which will cause a YAML parsing error or result in one configuration overwriting the other.
Apply this diff to remove the duplicate:
- snmp_groups:
-
- - group_name: V2
- snmp_version: 2
- snmp_secname:
- snmp_community: YOUR_SNMP_COMMUNITY
- snmp_port: 161
- snmp_authprotocol:
- snmp_authpassword:
- snmp_privprotocol:
- snmp_privpassword:
- enabled: True
-
snmp_groups:Committable suggestion skipped: line range outside the PR's diff.
🤖 Prompt for AI Agents
In docs/docs/getting-started/configuration.md around lines 76 to 87, there is a
duplicate top-level snmp_groups key (also present at lines 89–108) which will
cause YAML parsing errors or overwrite data; remove the redundant snmp_groups
block (or merge its entries into the remaining snmp_groups list) so only one
snmp_groups key exists, ensuring all group entries are preserved under that
single list.
| | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | `core:` | YAML key describing the server configuration. | | ||
| | `system_directory:` | Location where temporary data files are stored. Make sure that the switchmap username has write access to it. defaults to the `var/` directory in the `switchmap-ng` root directory. | | ||
| | `log_directory:` | The directory where `switchmap-ng` places its log files. Make sure that the switchmap username has write access to it. Defaultsto the `log/`subdirectory of `system_directory` | |
There was a problem hiding this comment.
Fix spacing in "Defaultsto".
The word appears to have a missing space.
Apply this diff:
-| `log_directory:` | The directory where `switchmap-ng` places its log files. Make sure that the switchmap username has write access to it. Defaultsto the `log/`subdirectory of `system_directory` |
+| `log_directory:` | The directory where `switchmap-ng` places its log files. Make sure that the switchmap username has write access to it. Defaults to the `log/`subdirectory of `system_directory` |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | `log_directory:` | The directory where `switchmap-ng` places its log files. Make sure that the switchmap username has write access to it. Defaultsto the `log/`subdirectory of `system_directory` | | |
| | `log_directory:` | The directory where `switchmap-ng` places its log files. Make sure that the switchmap username has write access to it. Defaults to the `log/`subdirectory of `system_directory` | |
🧰 Tools
🪛 LanguageTool
[grammar] ~136-~136: Ensure spelling is correct
Context: ...tchmap username has write access to it. Defaultsto the log/subdirectory of `system_direc...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
In docs/docs/getting-started/configuration.md at line 136, the word "Defaultsto"
is missing a space; update the line to read "Defaults to the `log/` subdirectory
of `system_directory`" ensuring proper spacing between "Defaults" and "to" and
between the code span and "subdirectory".
| | `api_bind_port:` | The TCP port the dashboard server will use. Defaults to `7001`. In most cases this won\'t have to be changed. | | ||
| | `api_https:` | Set this to `true`if web browsers need to use HTTPs to access the dashboard server pages. Switchmap only uses the SSL capabilities of the pre-installed webserver of your choice to encrypt data sent over the network. Default `False`. | | ||
| | `api_password:` | The HTTPS simple authentication password that the dashboard server uses. Defaults to `None`. | | ||
| | `api_username:` | The HTTPS simple authentication username that the dashbord server uses. Defaults to `None`. | |
There was a problem hiding this comment.
Fix typo: "dashbord" should be "dashboard".
The word "dashboard" is misspelled in the parameter descriptions.
Apply this diff:
-| `api_username:` | The HTTPS simple authentication username that the dashbord server uses. Defaults to `None`. |
+| `api_username:` | The HTTPS simple authentication username that the dashboard server uses. Defaults to `None`. |-| `api_username:` | The HTTPS simple authentication username that the dashbord server uses. Defaults to `None`. |
+| `api_username:` | The HTTPS simple authentication username that the dashboard server uses. Defaults to `None`. |Also applies to: 183-183
🧰 Tools
🪛 LanguageTool
[grammar] ~156-~156: Ensure spelling is correct
Context: ...simple authentication username that the dashbord server uses. Defaults to None. ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
In docs/docs/getting-started/configuration.md around lines 156 and 183, the word
"dashbord" is misspelled; update both occurrences to "dashboard" in the
parameter descriptions so the text reads "The HTTPS simple authentication
username that the dashboard server uses." (apply the same correction for any
similar phrasing on both lines).
|
|
||
| ``` | ||
| (venv) $ tests/bin/_do_all_tests.py | ||
| ``` | ||
|
|
||
| An alternative method is to use pytest. | ||
|
|
||
| ``` | ||
| (venv) $ pytest tests/switchmap_ | ||
| ``` | ||
|
|
||
| You can run individual tests with this command. | ||
|
|
||
| ``` | ||
| (venv) $ tests/switchmap_/path/to/test.py | ||
| ``` No newline at end of file | ||
| ``` |
There was a problem hiding this comment.
Add language specifiers to three code fences.
Per markdownlint (MD040), fenced code blocks should have a language specified. Three blocks are missing them:
- Line 356:
```→```bash - Line 362:
```→```bash - Line 368:
```→```bash
Apply this diff to fix:
- ```
+ ```bash
(venv) $ tests/bin/_do_all_tests.py
- ```
+ ```bash
An alternative method is to use pytest.
- ```
+ ```bash
(venv) $ pytest tests/switchmap_
- ```
+ ```bash
You can run individual tests with this command.
- ```
+ ```bash
(venv) $ tests/switchmap_/path/to/test.py
- ```🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
356-356: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
362-362: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
368-368: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
In docs/docs/getting-started/installation.md around lines 355 to 370, three
fenced code blocks are missing language specifiers; update the opening fence on
line 356, 362, and 368 to include "bash" (i.e., change ``` to ```bash for each
of those three blocks) so each code fence is language-specified per markdownlint
MD040; ensure you only modify the opening fence lines and leave the enclosed
lines unchanged.
| 1. The University of the West Indies Computing Society. (Kingston, | ||
| Jamaica) | ||
| Jamaica) | ||
| 2. The University of Techology, IEEE Student Branch. (Kingston, |
There was a problem hiding this comment.
Fix typo: "Techology" should be "Technology".
Apply this diff:
-2. The University of Techology, IEEE Student Branch. (Kingston,
+2. The University of Technology, IEEE Student Branch. (Kingston,
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 2. The University of Techology, IEEE Student Branch. (Kingston, | |
| 2. The University of Technology, IEEE Student Branch. (Kingston, |
🧰 Tools
🪛 LanguageTool
[grammar] ~79-~79: Ensure spelling is correct
Context: ...gston, Jamaica) 2. The University of Techology, IEEE Student Branch. (Kingston, Jam...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
In docs/docs/getting-started/introduction.md at line 79 the word "Techology" is
misspelled; change "The University of Techology, IEEE Student Branch.
(Kingston," to "The University of Technology, IEEE Student Branch. (Kingston,"
so the institution name is spelled correctly.
c26cecb
into
PalisadoesFoundation:develop
1 participant
Updated links to developer.palisadoes.org
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.