Repository navigation
docs: demo guide, README header and landing fixes - #6
Merged
Merged
Conversation
- ROADMAP: phase 4 closed; public since 2026-10-05 with secret scanning and push protection on and no alerts. - SESSION: next steps start at «Después de publicar». Why: the docs still said the repository was private.
- main is protected by the protect-main ruleset: PR only, backend and frontend checks required, merge commits only, no force push or deletion. Why: whoever picks up the work must know a direct push to main is refused.
- docs/demo/README.md: who uses it, what the demo account can and cannot do (with the routes), the data behind it, the limits, and how the reset runs. - The reset has no fixed time: it runs on the first demo entry of each day (Madrid), because Render's free plan sleeps after 15 minutes without traffic and a scheduled job would rarely run. - Linked from the root README and docs/general. Why: the demo was only described in a few lines of docs/general and in the code comments.
- docs/ROADMAP.md moves to docs/_archive (ignored); ADR-041 records it and the commit to recover it. - TODO: a dependency between items is stated in the item itself. - SESSION: drops ROADMAP from the language note and the archive step. Why: every publication phase closed on 2026-10-05, and a finished plan at the top of docs/ reads as live work.
- GITCLEAN: the publication step is done (archive repo archived, repo public, secret scanning and push protection on, no alerts). - VERIFY: automatic deploys confirmed for Vercel; Render's stays unchecked, it does not report to GitHub. Why: both documents are about to be archived and must not end with pending marks that were already done.
- GITCLEAN.md and VERIFY.md join ROADMAP.md in docs/_archive/open-source-release/ (ignored), with a README saying what each one holds. - ADR-041 now covers the three and the commit that recovers them. - SESSION and docs/general stop pointing to the moved files. Why: they told the move from private to public, which is finished, and read better together than as live documents in docs/.
…ommit - The header lists where archived documents are recorded (ADR-040, ADR-041) and that docs/_archive is the local, ignored copy. - ADR-041 gives one command per file: ROADMAP.md left the tree in 04808ab, so it is recovered from 5f0daa2, not 025e76c. Why: docs/_archive is not in the public repo, so the only lasting reference is the commit in the history, and one of them was wrong.
- State: public repo, the three environments, the local install, the archived publication documents. - Start here: the repo is public, and the branch → preview → PR flow. - Next: the post-publication TODO by priority. - Watch out: protected main, preview sharing the production database and cookies, the demo guards and seed, the remaining broken references. - Drops stale lines: phases, the AGENTS.md corrections (already applied). Why: the session still read as the publication in progress.
- «Get Started» becomes «Try the live demo» (the login page, where the demo button is); «Live demo →» linked to the portfolio and becomes «Source code →». - The source code button linked to the GitHub profile; it now opens the repository, and the text no longer says the backend is private. - The three generic features become the real ones: built from front-desk operations, the OR-Tools shift solver, open source with a demo. - «for desktop y mobile» and «© 2025 for-Points. All rights reserved.» become «for desktop and mobile» and «© 2026 Four-Points · MIT License». - Removes frontend/public/customers/: six photos from the Next.js tutorial that nothing uses. Why: the landing sent visitors to the wrong places and described the project as partly private.
- Low-priority entry: an article in the portfolio blog on how the front-desk rosters are modelled with OR-Tools, linking the demo and repo. Why: the solver is the strongest angle to promote the public project.
- One line on what it is and its strongest feature, the scheduler. - Three badges: live demo, CI, MIT licence. - Screenshots of the production demo (dashboard, a solved roster, parking), taken with Playwright in its own browser at 1440x900, in docs/images/. Why: the README started with plain text; a visitor now sees the app and the demo link before anything else.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
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.
Cambios
docs/demo/README.md: cómo funciona la demo pública y cuándo se reinicia.frontend/public/customers/.Por qué
El repo ya es público: la documentación y la portada deben llevar a la demo y al código.