Skip to content

Conversation

@dipinknair
Copy link
Contributor

Combine packaging, coding and documentation styles under Style section

@dipinknair dipinknair self-assigned this Jan 30, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 30, 2024
@dipinknair dipinknair marked this pull request as draft January 30, 2024 16:32
Review from @PipKat

Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
@dipinknair dipinknair marked this pull request as ready for review January 31, 2024 16:37
@dipinknair
Copy link
Contributor Author

dipinknair commented Jan 31, 2024

image

dipinknair and others added 3 commits January 31, 2024 18:57
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
@RobPasMue
Copy link
Member

These are breaking changes. Before merging we should inform everybody. Links will start to fail all around our docs.

@RobPasMue
Copy link
Member

These are breaking changes. Before merging we should inform everybody. Links will start to fail all around our docs.

My bad - it won't break anything. Each subsection will still be at the same URL since you didn't move the files. You just created a new one. All good from my side!

@PipKat
Copy link
Member

PipKat commented Feb 1, 2024

These are breaking changes. Before merging we should inform everybody. Links will start to fail all around our docs.

My bad - it won't break anything. Each subsection will still be at the same URL since you didn't move the files. You just created a new one. All good from my side!

@RobPasMue Not that I've had any time to move content from the PyAnsys writer's guide into the dev guide, but if I did, I feel like I'd need a strategic meeting with you to discuss how best to integrate it. Chris H. suggested reorganizing the dev guide as I do the integration, but I'm sure that would result in broken links.

@RobPasMue
Copy link
Member

These are breaking changes. Before merging we should inform everybody. Links will start to fail all around our docs.

My bad - it won't break anything. Each subsection will still be at the same URL since you didn't move the files. You just created a new one. All good from my side!

@RobPasMue Not that I've had any time to move content from the PyAnsys writer's guide into the dev guide, but if I did, I feel like I'd need a strategic meeting with you to discuss how best to integrate it. Chris H. suggested reorganizing the dev guide as I do the integration, but I'm sure that would result in broken links.

Yep, we should have a meeting prior to that taking place because it would break many people's repos. Let's talk offline! :)

@dipinknair dipinknair merged commit 6f6af75 into main Feb 1, 2024
@dipinknair dipinknair deleted the doc/styles-merge branch February 1, 2024 18:08
github-actions bot pushed a commit that referenced this pull request Feb 1, 2024
* combine all style to one page

* Apply suggestions from code review

Review from @PipKat

Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>

* adjusting bullet list

* header links are only 4 so no longer needed

* Update doc/source/all-styles.rst

Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>

* removing spacing between bulletlist

* adding hyperlink

* reformatting

---------

Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants