docs: fix incorrect claims, add missing tools, and release guide#193
Open
vredchenko wants to merge 1 commit intomainfrom
Open
docs: fix incorrect claims, add missing tools, and release guide#193vredchenko wants to merge 1 commit intomainfrom
vredchenko wants to merge 1 commit intomainfrom
Conversation
Fix factual errors identified in docs audit (#187): - Correct ARIA definition (was claimed to be image analysis system) - Replace phantom tools in api-server.md with actual simulator - Rewrite generate-docs.md (was referencing nonexistent tox command) - Fix database.md migration list (enumerate all 6, replace stale ID) - Document 4 missing tools: check_schema_drift, db_table_totals, generate_api_docs, makeiso - Add release procedure guide covering all 3 releasable packages - Link releasing and PyPI setup docs in operations index
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
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.
Summary
PR 1 of the documentation audit (#187). Fixes factually incorrect content, fills completeness gaps, and adds a release procedure guide.
simulate_msgmodule andsimulate-messages.shwith actualexternal_message_simulator.py; clarifieddev-k8s.shlives in smartem-devtoolstox -e docsreference with actual MDX sync + webui workflow6e6302f1ccb6with actual migration filenamecheck_schema_drift.py,db_table_totals.py,generate_api_docs.py,makeiso.shdocs/operations/releasing.md) covering smartem-decisions, smartem-epuplayer, and smartem-workspace — tag conventions, versioning, artifacts, manual releases, verification, uvx cache gotchaTest plan
cd webui && npm run buildpasses — all docs sync and compile without errorsRef: #187