Skip to content

Commit

Permalink
Renumber developer and reference in the docs (#275)
Browse files Browse the repository at this point in the history
  • Loading branch information
abelsiqueira authored Jun 13, 2024
1 parent e3358f7 commit a71d77f
Show file tree
Hide file tree
Showing 8 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Feel free to create a pull request to add your repo.

If you would like to get involved in the COPIERTemplate growth, please check our [contributing guide](docs/src/90-contributing.md). We welcome contributions of many types, including coding, reviewing, creating issues, creating tutorials, interacting with users, etc. Make sure to follow our [code of conduct](CODE_OF_CONDUCT.md).

If your interest is in developing the package, check the [development guide](docs/src/90-developer.md) as well.
If your interest is in developing the package, check the [development guide](docs/src/91-developer.md) as well.

## References

Expand Down
8 changes: 4 additions & 4 deletions docs/src/20-explanation.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ On top of the basic structure, we add some Documenter.jl structure.
- docs/
- src/
- 90-contributing.md
- 90-developer.md
- 90-reference.md
- 91-developer.md
- 95-reference.md
- index.md
- make.jl
- Project.toml
Expand All @@ -94,8 +94,8 @@ Brief explanation of the details:

- The `Project.toml`, `make.jl` and `src/index.md` are the basic structure.
- `docs/src/90-contributing.md`: Sometimes added as CONTRIBUTING.md, it explains how contributors can get involved in the project.
- `docs/src/90-developer.md`: Sometimes added as README.dev.md or DEVELOPER.md, it explains how to setup your local environment and other information relevant for developers only.
- `docs/src/90-reference.md` is the API reference page, which include an `@autodocs`.
- `docs/src/91-developer.md`: Sometimes added as README.dev.md or DEVELOPER.md, it explains how to setup your local environment and other information relevant for developers only.
- `docs/src/95-reference.md` is the API reference page, which include an `@autodocs`.

One noteworthy aspect of our `make.jl`, is that we include some code to automatically generate the list of pages.
Create a file in the form `##-name.md`, where `##` is a two-digit number, and it will be automatically added to the pages list.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/90-contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Otherwise, say what your proposed solution is and wait for a discussion around i
!!! tip
Feel free to ping us after a few days if there are no responses.

If your solution involves code (or something that requires running the package locally), check the [developer documentation](90-developer.md).
If your solution involves code (or something that requires running the package locally), check the [developer documentation](91-developer.md).
Otherwise, you can use the GitHub interface directly to create your pull request.

## Additions and modifications to the template
Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/src/90-reference.md → docs/src/95-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
## Contents

```@contents
Pages = ["90-reference.md"]
Pages = ["95-reference.md"]
```

## Index

```@index
Pages = ["90-reference.md"]
Pages = ["95-reference.md"]
```

```@autodocs
Expand Down
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ I hope you find this package useful. If you have any questions, requests, or com

If you would like to get involved in the COPIERTemplate growth, please check our [contributing guide](90-contributing.md). We welcome contributions of many types, including coding, reviewing, creating issues, creating tutorials, interacting with users, etc. Make sure to follow our [code of conduct](https://github.com/abelsiqueira/COPIERTemplate.jl/blob/main/CODE_OF_CONDUCT.md).

If your interest is in developing the package, check the [development guide](90-developer.md) as well.
If your interest is in developing the package, check the [development guide](91-developer.md) as well.

## References

Expand Down
2 changes: 1 addition & 1 deletion template/docs/src/90-contributing.md.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ Otherwise, say what your proposed solution is and wait for a discussion around i
!!! tip
Feel free to ping us after a few days if there are no responses.

If your solution involves code (or something that requires running the package locally), check the [developer documentation](90-developer.md).
If your solution involves code (or something that requires running the package locally), check the [developer documentation](91-developer.md).
Otherwise, you can use the GitHub interface directly to create your pull request.
4 changes: 2 additions & 2 deletions template/docs/src/90-reference.md.jinja
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
## Contents

```@contents
Pages = ["90-reference.md"]
Pages = ["95-reference.md"]
```

## Index

```@index
Pages = ["90-reference.md"]
Pages = ["95-reference.md"]
```

```@autodocs
Expand Down

0 comments on commit a71d77f

Please sign in to comment.