Update docs with CI info, remove redundant docs, git-workflow (Close #862, #1009, #1105) #1110
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
Author
|
Noticed a bunch of errors: |
Collaborator
|
@avivajpeyi , is this ready for review? |
Collaborator
Author
|
Hey @ilyamandel -- apologies, haven't finished this up yet! |
Collaborator
|
@avivajpeyi -- CI is still giving incorrect failure messages, now there seem to be "pip install" issues... Any chance you might be able to fix these? |
…PAS/COMPAS into update_docs_with_git_and_ci_info
Collaborator
Author
|
OK, still some broken files: |
Collaborator
Author
|
I still havent finished all the spelling errors etc, but maybe we can just merge this in for now. |
Collaborator
|
@avivajpeyi -- thank you for all of this work! I didn't review the documentation changes (thanks for that, @jeffriley ), but there seem to be some blank squares that look like missing images (?) at https://compas.readthedocs.io/en/latest/pages/Getting%20started/dev-git-workflow.html -- can you check if there's a bad link somewhere? |
Collaborator
|
Example: 
|
Collaborator
|
We know there are some broken links in the docs - they do need to be fixed
(I thought they were all in the tutorial/notebooks).
I don't really like long docs pages (e.g.
https://compas.readthedocs.io/en/latest/pages/Getting%20started/dev-git-workflow.html
),
but if we're going to have them (rather than splitting them into several
smaller pages), can we at least have links back to the top of the page at
each of the sections (something like the "Back to top" links we have on the
properties/options pages)? We have links to each of the sections, but if I
want to go back to the top of the page (maybe to jump to a different
section), I have to scroll up.
Jeff
…--
Dr Jeff Riley
Monash University, Australia
Ph: +61 (0)407 811 282
***@***.***
On Wed, 4 Dec 2024 at 15:13, Ilya Mandel ***@***.***> wrote:
@avivajpeyi <https://github.com/avivajpeyi> -- thank you for all of this
work! I didn't review the documentation changes (thanks for that,
@jeffriley <https://github.com/jeffriley> ), but there seem to be some
blank squares that look like missing images (?) at
https://compas.readthedocs.io/en/latest/pages/Getting%20started/dev-git-workflow.html
-- can you check if there's a bad link somewhere?
—
Reply to this email directly, view it on GitHub
<#1110 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AGM5XNRRC75YIFL47CDVGWL2DZ6OBAVCNFSM6AAAAABHILAM4SVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKMJWGE2DONRSHA>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Close #862, #1009, #1105