Add linting and improved documentation #1

	---
	# Copyright The Linux Foundation and each contributor to LFX.
	# SPDX-License-Identifier: MIT

	name: Lint

	'on':
	push: null
	pull_request: null

	permissions:
	contents: read

	jobs:
	build:
	name: Lint
	runs-on: ubuntu-latest

	permissions:
	contents: read
	packages: read
	# To report GitHub Actions status checks
	statuses: write

	steps:
	- name: Checkout code
	uses: actions/checkout@v4
	with:
	# super-linter needs the full git history to get the
	# list of files that changed across commits
	fetch-depth: 0

	- name: Super-linter
	uses: super-linter/[email protected]
	env:
	# To report GitHub Actions status checks
	GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Provide feedback