Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add readme / TOC #2

Closed
meichthys opened this issue Jun 5, 2024 · 2 comments
Closed

Add readme / TOC #2

meichthys opened this issue Jun 5, 2024 · 2 comments
Assignees
@root-hal9000
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers initial-review adds to initial-review project

Comments

@meichthys
Copy link
Contributor

The readme should act as a table of contents for the docs (see the original Trilium wiki for the table of content layout).

The order of the pages could be re-arranged if it makes sense to do so.
@meichthys meichthys added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Jun 5, 2024
@meichthys meichthys changed the title Add readme Add readme / TOC Jun 6, 2024
@root-hal9000
Copy link
Contributor

I can take that on sometime next week.

@root-hal9000 root-hal9000 added initial-review adds to initial-review project and removed help wanted Extra attention is needed labels Jul 3, 2024
root-hal9000 added a commit to root-hal9000/Docs that referenced this issue Jul 6, 2024
@root-hal9000
TOC and file renaming
3c6d1aa 
- 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 TriliumNext#2
- Separated "importing docs" text into a separate file
- Added a few %%{WARNING}%% tags to links that go to zadams repos. Issue TriliumNext#87
@root-hal9000 root-hal9000 mentioned this issue Jul 6, 2024
Merged
Alumniminium pushed a commit that referenced this issue Jul 7, 2024
@root-hal9000 @Alumniminium
TOC and file renaming
485e467 
- 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
@Alumniminium
Copy link
Contributor

Thanks @root-hal9000, I've merged it into main.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@root-hal9000 root-hal9000

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers initial-review adds to initial-review project
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@root-hal9000 @meichthys @Alumniminium