Skip to content

Docs: Update v1 docs path#2836

Merged
gchtr merged 7 commits into2.xfrom
update-v1-docs-path
Nov 9, 2023
Merged

Docs: Update v1 docs path#2836
gchtr merged 7 commits into2.xfrom
update-v1-docs-path

Conversation

@Levdbas
Copy link
Copy Markdown
Member

@Levdbas Levdbas commented Nov 3, 2023

Related:

Issue

As discussed in timber/docs#80 we are going to update the docs to live under their own /v1/ and /v2/ prefix. For that to work we need to update all the links in the repo where needed.

Solution

Fix all the links and while at it, I fixed a few more links as well that were pointing from v2 docs back to v1 or links that were pointing to a non-existing anchor link.

Impact

Hopefully minimal. I double checked all the links but it might be so that I missed one or I messed up a path. But that should be close to zero.

Considerations

We refer a few times to https://timber.github.io/docs/reference/. But this page is not working at the moment. @gchtr , can you recall if that index file worked some time ago? And should we fix it? If not, we might want to update these paths (2 times in contributing.md and 1 time in readme.md) as well.

@coveralls
Copy link
Copy Markdown

Coverage Status

coverage: 88.528%. remained the same
when pulling ef3da5b on update-v1-docs-path
into dbb7139 on 2.x.

@gchtr gchtr added the 2.0 label Nov 3, 2023
@gchtr
Copy link
Copy Markdown
Member

gchtr commented Nov 7, 2023

We refer a few times to timber.github.io/docs/reference. But this page is not working at the moment. @gchtr , can you recall if that index file worked some time ago? And should we fix it? If not, we might want to update these paths (2 times in contributing.md and 1 time in readme.md) as well.

@Levdbas Yes, I see. These archive pages worked at some time, I guess. I added a fix, see timber/docs#80 (comment).

gchtr
gchtr previously approved these changes Nov 7, 2023
Copy link
Copy Markdown
Member

@gchtr gchtr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is looking goood!

Let’s wait with merging this. We’re going to merge it together with the release.

@gchtr gchtr merged commit 34487d9 into 2.x Nov 9, 2023
@gchtr gchtr deleted the update-v1-docs-path branch November 9, 2023 06:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants