chore(docs): move the documentation sources out of the repository - #7
Open
krlex wants to merge 2 commits into
Open
chore(docs): move the documentation sources out of the repository#7krlex wants to merge 2 commits into
krlex wants to merge 2 commits into
Conversation
The markdown sources stay on the host and are no longer carried in the public repo. What the outside world reads is the generated site at forail-platform.github.io, built from those sources. 84 files leave the index; nothing leaves the disk. They do remain in the existing history -- removing them from past commits would mean rewriting every branch and tag, which is not done here.
README and CONTRIBUTING linked into docs/, which this repo no longer ships. Both now point at forail-platform.github.io, and the README's documentation section lists the published pages instead of file paths.
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.
The markdown sources stay on the host; what the outside world reads is the generated site at forail-platform.github.io, built from those sources.
docs/is removed from the index (84 files) and added to.gitignore. Nothing leaves the disk — the files are untouched locally.README.mdandCONTRIBUTING.mdlinked intodocs/; both now point at the published pages, and the README's documentation section lists site URLs instead of file paths.CONTRIBUTING.mdlink in the other seven repos, which all pointed atforail-devops/blob/main/docs/10-contributing-guide.md.Caveat worth stating plainly: the files remain in this repo's existing history and stay visible to anyone who clones it. Removing them from past commits means rewriting every branch and tag — a separate, much larger operation, not done here.