TOC and file renaming - Githubissues

TriliumNext / Docs

Documentation for TriliumNext

https://triliumnext.github.io/Docs/

6 stars 7 forks source link

TOC and file renaming #88

Closed root-hal9000 closed 3 months ago

root-hal9000 commented 3 months ago

renamed all files to be lowercase and have no spaces
Updated all references to those names in file content
Recreated table of contents into readme.MD Issue #2
Separated "importing docs" text into a separate file
Added a few %%{WARNING}%% tags to links that go to zadams repos. Issue #87

root-hal9000 commented 3 months ago

Please delete the old files with MixedCase.

Oops, sorry about that, they had been deleted (I originally renamed them with a bash script) but I had issues commiting and re-cloned to copy my changes over and didn't notice that. Will do

root-hal9000 commented 3 months ago

OK, deleted the old files - anything else here or should I merge. If someone merges, create a new initial-review branch from main after merging this.

Also, I forgot to note that I did make some slight changes to the order of the TOC as suggested in issue #2 - mostly just moving things for newer users up the TOC in places where order didn't necessarily matter (e.g.: desktop installation before all the different server installation instructions)

maphew commented 3 months ago

was all of this work scripted? I presume yes or mostly. Perhaps put them in /utils or something, or at least keep the transition scripts handy in the event there's more changes upstream. I don't think there's a high probability of that, but have been bitten many times in the past by the thought "we'll only need to do this once" ... ;-)

root-hal9000 commented 3 months ago

was all of this work scripted? I presume yes or mostly.

Only the renaming of the files to lowercase/no space (and replacing of the links referring to them). The TOC was manual as there's no inherent structure in the files for that and I made some slight changes to the order. Sorry, it was more clear with separate commits but I wound up having to squash it all

It was a quick and dirty thing, but I can add it

Alumniminium commented 3 months ago

oh god i should have merged that from the terminal and not from the web... what just happened

root-hal9000 commented 3 months ago

oh god i should have merged that from the terminal and not from the web... what just happened

Just got out of the meeting, not sure what you're referring to, although I see a couple of new branches?

Also, I should have made the PR to the main branch, no? We should merge this into main, and then pull the initial-review branch from there

Alumniminium commented 3 months ago

Done. I've merged that branch into main and created an 'initial-review' branch from the new main. @root-hal9000