Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# Guidance for coding agents

This repository is documentation only. There is no application code here.

## Ground rules

- Do not invent behavior. Verify every technical claim against the actual
repository before writing it. If you cannot verify it, say so or omit it.
- Distinguish the target from the current state. Mark aspirational rules as
goals and point at [REPOS.md](REPOS.md) for what each repo does today.
- Keep docs as the single source of truth. Do not duplicate the same guidance
across files; link instead.
- Prefer editing an existing file over adding a new one.

## Writing

- All docs are Markdown with the `.md` extension, lowercase.
- Follow [style/README_STANDARDS.md](style/README_STANDARDS.md): Title Case
headings, fenced code blocks with a language hint, neutral tone.
- Use relative links for files in this repo and full URLs for everything else.
When you rename a file, update every link to it (grep for the old name).
- Keep the tables in [README.md](README.md), [workflow/README.md](workflow/README.md),
and [style/README.md](style/README.md) in sync with the files on disk.

## CI and lint

- `shellcheck` covers tracked shell scripts (`install.sh`).
- `actionlint` covers `.github/workflows/`.
- Run both before committing; see [style/WORKFLOW.md](style/WORKFLOW.md).

## Git

- PRs target `main`.
- One concern per PR.
- Use conventional commit subjects (`docs:`, `ci:`, `fix:`, `chore:`).

## Keeping REPOS.md current

`REPOS.md` is a snapshot of the other repositories. When you change a documented
convention or a repo changes its branch, packaging, tooling, or license, update
the matching row and, if the change resolves a deviation, move or remove that
entry under "Deviations from target".
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ curl -vfSL http://wlanpi.us/install | sudo bash
| [Anti-patterns](style/ANTIPATTERNS.md) | Common mistakes to avoid |
| [Debchange](style/DCH.md) | Changelog formatting |
| [Developer Workflow](style/WORKFLOW.md) | Development process standards |
| [Manpages](style/MANPAGES.MD) | Creating and generating manpages for WLAN Pi applications |
| [Manpages](style/MANPAGES.md) | Creating and generating manpages for WLAN Pi applications |

### Workflow

Expand All @@ -64,7 +64,7 @@ curl -vfSL http://wlanpi.us/install | sudo bash
| [IDE Setup](workflow/ide.md) | IDE configuration |
| [Developing on Windows](workflow/dev-on-windows.md) | Windows/WSL development guide |
| [Update from Dev Branch](workflow/update-from-dev.md) | Testing dev packages |
| [VSC Remote-SSH](workflow/VSC_64bit_kernel_and_32bit_userland.md) | VS Code troubleshooting |
| [VSC Remote-SSH](workflow/archive/VSC_64bit_kernel_and_32bit_userland.md) | VS Code troubleshooting (archived) |

### Licensing

Expand Down
17 changes: 0 additions & 17 deletions architecture/PACKAGING.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,23 +199,6 @@ Before submitting:
3. Service runs: `sudo systemctl status wlanpi-yourapp`
4. Application works: `wlanpi-yourapp --help`

## OSS attribution

If your package relies on other open source projects, document them in `OSS.md` at the repository root:

```markdown
# Open Source Attribution

## Dependencies

- library-name (License): Description
- Source: https://github.com/user/repo

## Included Assets

- Asset name (License): Description
```

## References

- [Packaging Example](../PACKAGING_EXAMPLE.md) - Complete walkthrough with code
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion style/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
- [Contributing](../CONTRIBUTING.md)
- [Debchange](DCH.md)
- [Developer Workflow](WORKFLOW.md)
- [Manpages](MANPAGES.MD)
- [Manpages](MANPAGES.md)
- [Packaging](../architecture/PACKAGING.md)
- [Python](PYTHON.md)
- [README Standards](README_STANDARDS.md)
Expand Down
8 changes: 7 additions & 1 deletion workflow/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,11 @@ Development environment guides and platform-specific setup for WLAN Pi contribut
| [Development Setup](development-setup.md) | Setting up a local development environment |
| [IDE Selection](ide.md) | Editor and IDE options for WLAN Pi development |
| [Developing on Windows](dev-on-windows.md) | Line ending and Git configuration for Windows |
| [VSC Remote-SSH Troubleshooting](VSC_64bit_kernel_and_32bit_userland.md) | Fixing VSC on arm64 kernel with 32-bit userland |
| [Update from Dev Branch](update-from-dev.md) | Updating a WLAN Pi device from the Packagecloud dev branch |

## Archived

| Document | Purpose |
|----------|---------|
| [VSC Remote-SSH Troubleshooting](archive/VSC_64bit_kernel_and_32bit_userland.md) | Fixing VSC on the old arm64-kernel/armhf-userland images |

Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Visual Studio Code (VSC) Remote-SSH Installation Troubleshooting

> **Archived.** This workaround applies to the old arm64-kernel/armhf-userland
> WLAN Pi images. Current images are arm64, so it is kept for historical
> reference only.

## Seeing `node not found` or VSC not launching in the Remote-SSH session?

Something like this during install:
Expand Down
10 changes: 5 additions & 5 deletions workflow/dev-on-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,34 +14,34 @@ The best approach is to force the use of `LF` line endings via the git environme
# global parameters to force all projects to use LF line endings

# list current settings
git confg --global -l
git config --global -l

# set line endings
git config --global core.autocrlf "false"
git config --global core.eol "lf"

# list new settings
git confg --global -l
git config --global -l
```

```
# local parameters to force a specific project to use LF line endings

# list current settings
git confg --global -l
git config --local -l

# set line endings
cd <project dir>
git config --local core.autocrlf "false"
git config --local core.eol "lf"

# list new settings
git confg --global -l
git config --local -l
```

## Checking line endings

The quick and easy way to check the line endings used in a file you are working on is to look at the status bar at the bottom right of the VSC UI. `LF` indicates the file is using only `LF` characters. `CRLF` indicates that the ile is using `CR` + `LF` characters (which is a bad thing). To change the line endings used, simply click the `CRLF` text and change it to `LF` using the drop-down provided at the top of the UI.
The quick and easy way to check the line endings used in a file you are working on is to look at the status bar at the bottom right of the VSC UI. `LF` indicates the file is using only `LF` characters. `CRLF` indicates that the file is using `CR` + `LF` characters (which is a bad thing). To change the line endings used, click the `CRLF` text and change it to `LF` using the drop-down provided at the top of the UI. To change the line endings used, simply click the `CRLF` text and change it to `LF` using the drop-down provided at the top of the UI.

![Line end indicator](img/lf.png)

Expand Down