Skip to content

Conversation

@PaulWessel
Copy link
Member

The Cookbook is actually our tecthnical reference and should be named as such. Any cooking takes place in the galleries. Closes #7776.

Fixed CookBook, cookbook, Cook Book etc and other variations, plus /cookbook -> /reference. Seems to build fine but probably some subtle mistakes. See what you think.

The Cookbook is actually our tecthnical reference and should be named as such.  Any cooking takes place in the galleries.  Closes #7776.
@PaulWessel PaulWessel added the documentation Improve documentation label Sep 5, 2023
@PaulWessel PaulWessel added this to the 6.5.0 milestone Sep 5, 2023
@PaulWessel PaulWessel requested a review from seisman September 5, 2023 08:30
@seisman
Copy link
Member

seisman commented Sep 5, 2023

I can still find many "cookbook"s that need changes. I'll push more changes directly to this PR.

@PaulWessel
Copy link
Member Author

OK, thanks. Must be hiding somewhere outside doc then:

find . -name '*.rst*' -exec grep -H '/cookbook' {} \; | wc  
0

@seisman
Copy link
Member

seisman commented Sep 5, 2023

@PaulWessel Should gmt docs cookbook be changed to gmt docs reference?

@PaulWessel
Copy link
Member Author

Yes, but we should accept either for backward protection. I can look at that.

@seisman
Copy link
Member

seisman commented Sep 5, 2023

@PaulWessel This PR should be good to merge, but please rebuild the docs to see if the docs building is successful. I can't build GMT recently due to my broken Homebrew pacakges.

@PaulWessel PaulWessel merged commit c9c8ac0 into master Sep 5, 2023
@PaulWessel PaulWessel deleted the rename-cookbook branch September 5, 2023 17:27
@PaulWessel
Copy link
Member Author

Heads up @joa-quim if your docs specifically looks for stuff. Both gmt docs cookbook and gmt docs reference will work.

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

Labels

documentation Improve documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rename Bookbook to Technical Reference

3 participants