Polish public release documentation#13
Open
Spbd1 wants to merge 1 commit into
Open
Conversation
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.
Motivation
Description
README.mdwith project description, research motivation, quick start, Docker start, demo credentials, architecture, research design, data exports, roadmap, and contributor guidance.docs/research-design.md,docs/game-mechanics.md,docs/data-dictionary.md,docs/analysis-plan.md,docs/admin-guide.md,docs/deployment.md, anddocs/ethics.mdfor release-readiness.CONTRIBUTING.md,CODE_OF_CONDUCT.md,CHANGELOG.md(v0.1.0), GitHub issue templates (.github/ISSUE_TEMPLATE/bug_report.md,feature_request.md,research_question.md), and a pull request template (.github/pull_request_template.md).docs/images/.gitkeepas a placeholder for release screenshots and run Prettier formatting over the edited Markdown files.Testing
pnpm exec prettier --write README.md docs/*.md CONTRIBUTING.md CODE_OF_CONDUCT.md CHANGELOG.md .github/ISSUE_TEMPLATE/*.md .github/pull_request_template.md, which completed successfully.git diff --check, which reported no issues.pnpm install, but it failed due to a registry/proxy403 Forbiddenfor dependencies (blocked by environment npm registry configuration), so dependency-driven checks could not complete.pnpm typecheck,pnpm lint,pnpm test, andpnpm buildwere not able to finish because dependencies were not installed; Docker-based Compose checks also could not run because Docker is not available in the environment.Codex Task