Skip to content

docs: remove old documentation - #47

Merged
dcamarmas merged 1 commit into
creatorsim:masterfrom
rajayonin:docs/cleanup
Jul 16, 2026
Merged

docs: remove old documentation#47
dcamarmas merged 1 commit into
creatorsim:masterfrom
rajayonin:docs/cleanup

Conversation

@rajayonin

Copy link
Copy Markdown
Member

Documentation already lives at https://creatorsim.github.io/creator-wiki/ (see creatorsim/creator-wiki#8), so this information is duplicate.

We leave a minimal HACKING.md with information about building and running the application.

@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@dcamarmas

Copy link
Copy Markdown

It's not a bad idea to do some cleaning up—we appreciate it. However, we think there are files that should be kept in the repository, even though they are on the wiki, because they are related to development. They are: version-management.md and vue-tricks.md

In addition, the file HACKING.md should be renamed build.md, which is a more academic and formal name that new developers might find more familiar.

@rajayonin

rajayonin commented Jul 14, 2026

Copy link
Copy Markdown
Member Author

I used the HACKING.md name because it's what I've seen in other projects like Ubuntu, GHC and Ghostty, but I can change it to BUILD.md (there are also other projects that use that).

Documentation already lives at
https://creatorsim.github.io/creator-wiki/, so this information is
duplicate. We still leave some importand dev-related docs like
`version-management.md` and `vue-tricks.md`.

We leave a minimal BUILD.md with information about building and running
the application.

Co-authored-by: Diego Camarmas-Alonso <dcamarma@inf.uc3m.es>
@dcamarmas
dcamarmas merged commit 8af9bbf into creatorsim:master Jul 16, 2026
15 checks passed
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.

2 participants