Fix/lint and doc updates#7
Merged
Merged
Conversation
Keep license/README references consistent and relocate Python lint requirements under scripts/.
- Write docs-check validation outputs under tmp/ and exclude tmp/ from markdownlint. - Add Go setup in go-ci. - Update generate-anchor workflow/Make targets to use file/line inputs to avoid backtick quoting issues. - Improve lint-python target to report all failures.
Split large script utilities into focused modules (validation, go_markdown, heading_numbering, index utils, and spec reference helpers) and update validation entrypoints and docs accordingly.
Update tech specs and requirements links/headings to reflect the current Package read/write operations framing and refresh the Go definitions index entries.
Align Go implementation and tests with the updated package read/write API surface, including path metadata handling, file index/header behavior, signatures, and supporting helpers.
Remove duplicate package state transition feature block and normalize PathMetadataPatch literal formatting.
cypher0n3
force-pushed
the
fix/lint-and-doc-updates
branch
from
a1bd8e4 to
cc1ae11
Compare
- CI: install lint tooling from scripts/requirements-lint.txt to match local - go_markdown/_base.py: add from __future__ import annotations for Signature forward ref
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR: fix/lint-and-doc-updates
Summary
Lint and documentation updates: repo hygiene, CI/tooling improvements, script refactors, spec/requirements alignment, Go API stabilization, and BDD feature cleanup.
What changed
Repo and CI
LICENSE→LICENSE.txt, updated README and AI instructions links. Movedrequirements-lint.txtintoscripts/and updated Makefile/venv references.tmp/; markdownlint excludes#tmp/**. Go CI workflow adds explicit Go 1.25 setup and cache.TEXT='...'to file/line inputs (FILE='path/to/file.md',LINE='path/to/file.md:224') to avoid backtick quoting issues; updated copilot and AI coding instructions accordingly.go-fmttarget; golangci-lint runs once with full tree.Scripts and validation
scripts/lib/validation/,scripts/lib/go_markdown/,scripts/lib/heading_numbering/, index parsing/rendering, and spec-reference/heading/link helpers. Validation entrypoints andscripts/README.mdupdated.Docs and specs
docs/requirementsanddocs/tech_specswith the current Package read/write operations framing (replacing PackageReader/PackageWriter-centric headings/links). Refreshed Go definitions index content and numbering.Go API and tests
api/go/metadata. Signatures, fileformat, generics, and novus_package updates for consistency and lint.BDD features