Skip to content

docs: prepare student feedback - #54

Merged
michalmaj merged 1 commit into
mainfrom
docs/prepare-student-feedback
Sep 30, 2026
Merged

michalmaj merged 1 commit into
mainfrom
docs/prepare-student-feedback

Conversation

@michalmaj

Copy link
Copy Markdown
Owner

Summary

Prepare the guide for its first tagged release and structured feedback from students.

Why

The project now has a complete learning path and a published site. Clear project badges and focused issue forms make its status visible and give learners an easy way to share useful feedback.

Changes

  • add accurate badges for workflows, release status, Python, project tools, license, issues, and student feedback
  • add a dedicated README section linking directly to feedback paths
  • add a learning feedback form for students and other learners
  • add a problem report form for incorrect instructions, commands, examples, and site behavior
  • disable blank public issues so contributors start with one of the structured forms
  • update the documented project structure and roadmap

Type of change

  • Documentation
  • Project configuration
  • New feature
  • Tests
  • CI/CD
  • Refactoring
  • Bug fix

Checklist

  • The change is small and focused
  • The pull request title is clear
  • I updated documentation if needed
  • I added or updated tests if needed
  • I ran local checks if applicable

Notes

The release badge will begin showing the version after the first tag and GitHub Release are created from the merged main commit.

Local verification:

  • uv run pre-commit run --all-files
  • uv run rumdl check .
  • uv run mkdocs build --strict
  • uv run pytest --cov=text_toolkit --cov-report=term-missing
  • uv run mypy
  • uv run ruff check .
  • uv run ruff format --check .
  • uv sync --locked --group dev
  • uv build --no-sources

@michalmaj
michalmaj merged commit 1057d08 into main Sep 30, 2026
1 check passed
@michalmaj
michalmaj deleted the docs/prepare-student-feedback branch September 30, 2026 10:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant