Skip to content

Commit

Permalink
Update links to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
schemar committed May 31, 2022
1 parent 5608c02 commit 11924a4
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 9 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Every contribution is much appreciated!
## Updating documentation

The documentation resides under the `./docs` directory.
It consists of markdown files, which [Jekyll](https://jekyllrb.com/) will transform into web pages that you can view at <https://schemar.github.io/obsidian-tasks/> .
It consists of markdown files, which [Jekyll](https://jekyllrb.com/) will transform into web pages that you can view at <https://obsidian-tasks-group.github.io/obsidian-tasks/> .
In the simplest case, you can update the existing markdown file and create a pull request (PR) with your changes.

We use [GitHub pages](https://pages.github.com/) for our documentation.
Expand All @@ -15,7 +15,7 @@ You can read more about it at their [official documentation](https://docs.github
To generate the documentation site on your machine,
see [docs/README.md](docs/README.md).

For documentation changes to show up at <https://schemar.github.io/obsidian-tasks/> , they must be in the `gh-pages` branch.
For documentation changes to show up at <https://obsidian-tasks-group.github.io/obsidian-tasks/> , they must be in the `gh-pages` branch.
If you want to see your changes available immediately and not only after the next release, you should make your changes on the `gh-pages` branch.
When you create a PR, it should merge into the `gh-pages` branch as well.
If you document an unreleased feature, you should update the documentation on `main` instead. Ideally together with the related code changes.
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<p align="center">Task management for the <a href="https://obsidian.md/">Obsidian</a> knowledge base.</p>

<p align="center"><a href="https://schemar.github.io/obsidian-tasks/">Documentation</a></p>
<p align="center"><a href="https://obsidian-tasks-group.github.io/obsidian-tasks/">Documentation</a></p>

Track tasks across your entire vault. Query them and mark them as done wherever you want. Supports due dates, recurring tasks (repetition), done dates, sub-set of checklist items, and filtering.

Expand Down Expand Up @@ -43,7 +43,7 @@ Follow the steps below to install Tasks.

## Documentation

For user documentation, please check [https://schemar.github.io/obsidian-tasks/](https://schemar.github.io/obsidian-tasks/).
For user documentation, please check [https://obsidian-tasks-group.github.io/obsidian-tasks/](https://obsidian-tasks-group.github.io/obsidian-tasks/).

## Development

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
- The documentation is written in Markdown
- It is converted to HTML via Ruby and Jekyll
- Important: Ruby 2 is required, for example, Ruby 2.7
- The published documentation is at <https://schemar.github.io/obsidian-tasks/>
- The published documentation is at <https://obsidian-tasks-group.github.io/obsidian-tasks/>

## Test documentation locally with Jekyll

Expand Down
3 changes: 1 addition & 2 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
title: Obsidian Tasks
description: Task management for Obsidian
baseurl: "/obsidian-tasks" # the subpath of your site, e.g. /blog
url: "https://schemar.github.io" # the base hostname & protocol for your site, e.g. http://example.com
url: "https://obsidian-tasks-group.github.io" # the base hostname & protocol for your site, e.g. http://example.com

permalink: pretty

Expand All @@ -24,4 +24,3 @@ gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into t

# Build settings
remote_theme: pmarsceill/just-the-docs

2 changes: 1 addition & 1 deletion src/Query/Filter/StartDateField.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export class StartDateField extends DateField {
return task.startDate;
}
protected filterResultIfFieldMissing() {
// reference: https://schemar.github.io/obsidian-tasks/queries/filters/#start-date
// reference: https://obsidian-tasks-group.github.io/obsidian-tasks/queries/filters/#start-date
return true;
}
}
2 changes: 1 addition & 1 deletion tests/Query.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ describe('Query', () => {
'- [ ] task 4 🛫 2022-04-25',
],
expectedResult: [
'- [ ] task 1', // reference: https://schemar.github.io/obsidian-tasks/queries/filters/#start-date
'- [ ] task 1', // reference: https://obsidian-tasks-group.github.io/obsidian-tasks/queries/filters/#start-date
'- [ ] task 2 🛫 2022-04-15',
],
},
Expand Down

0 comments on commit 11924a4

Please sign in to comment.