EliteDangerous/VoiceAttack-profiles
1
0
Fork 0
Code Issues Pull requests 1 Projects Releases 33 Wiki Activity Actions

docs markdown fixes & author privacy on screenshot #149

Closed
ACyprus wants to merge 7 commits from devel into devel
pull from: devel
merge into: EliteDangerous:devel
Conversation 3 Commits 7 Files changed 10 +31 -35
ACyprus commented 2022-07-11 13:13:48 +02:00 (Migrated from github.com)
Copy link

This PR

  • applies some minor typo, grammatical, formatting fixes the the docs markdown
  • obscures author details in the neutron-plotter folder screenshot
  • does not includes changes that were discussed/rejected on Discord during the previous PR
### This PR - applies some minor typo, grammatical, formatting fixes the the docs markdown - obscures author details in the neutron-plotter folder screenshot - does not includes changes that were discussed/rejected on Discord during the [previous PR](https://github.com/alterNERDtive/VoiceAttack-profiles/pull/137)
alterNERDtive (Migrated from github.com) requested changes 2022-07-11 13:25:56 +02:00
alterNERDtive (Migrated from github.com) left a comment
Copy link

I can’t comment on the image file, but a) good spot! and b) please put a black rectangle there :)

I can’t comment on the image file, but a) good spot! and b) please put a _black_ rectangle there :)
docs/EliteAttack.md
alterNERDtive (Migrated from github.com) commented 2022-07-11 13:20:55 +02:00
Copy link

I believe the correct way to do this would be configuration/EliteAttack.md#settings.

Depending on the editor / IDE you’re using that might complain, but mkdocs (with roamlinks plugin) will resolve it just fine.

I believe the correct way to do this would be `configuration/EliteAttack.md#settings`. Depending on the editor / IDE you’re using that might complain, but mkdocs (with roamlinks plugin) will resolve it just fine.
docs/SpanshAttack.md
alterNERDtive (Migrated from github.com) commented 2022-07-11 13:17:03 +02:00
Copy link

This seems to be a bit wider than 80 characters!

This seems to be a bit wider than 80 characters!
docs/index.md
alterNERDtive (Migrated from github.com) commented 2022-07-11 13:22:09 +02:00
Copy link

Same here, should link to requirements.md.

Same here, should link to `requirements.md`.
docs/installing.md
alterNERDtive (Migrated from github.com) commented 2022-07-11 13:24:55 +02:00
Copy link

That link here does work. Is it about the ugly # in the text? :)

That link here does work. Is it about the ugly `#` in the text? :)
alterNERDtive commented 2022-07-11 13:31:08 +02:00 (Migrated from github.com)
Copy link

Oh and considering there is a merge commit in this pull request you should probably rebase this on my devel branch again.

Generally it’s a good idea to create a specific branch for work on a pull request, makes the inevitable rebasing easier.

Oh and considering there is a merge commit in this pull request you should probably rebase this on my `devel` branch again. Generally it’s a good idea to create a specific branch for work on a pull request, makes the inevitable rebasing easier.
ACyprus (Migrated from github.com) reviewed 2022-07-11 13:33:01 +02:00
docs/SpanshAttack.md
ACyprus (Migrated from github.com) commented 2022-07-11 13:33:01 +02:00
Copy link

I checked without the url in place at the time, it's below 80 so the wrapping should look good on the page.

I can change if needed though.

I checked without the url in place at the time, it's below 80 so the wrapping should look good on the page. I can change if needed though.
alterNERDtive (Migrated from github.com) reviewed 2022-07-11 13:34:34 +02:00
docs/SpanshAttack.md
alterNERDtive (Migrated from github.com) commented 2022-07-11 13:34:33 +02:00
Copy link

Yeah, the character limit is for pretty printing the source file. Rendered text will flow based on the style sheet anyway.

Yeah, the character limit is for pretty printing the _source_ file. Rendered text will flow based on the style sheet anyway.
ACyprus (Migrated from github.com) reviewed 2022-07-11 13:36:33 +02:00
docs/EliteAttack.md
ACyprus (Migrated from github.com) commented 2022-07-11 13:36:33 +02:00
Copy link

I checked it earlier using the mkdocs linked preview tool and seemed ok, but you're right, I'll add the page too for clarity in a moment.

I added the parent directory dots because the original link is broken, I have no way to test those though according to the mkdocs docs they "should" work OK. lmk.

I checked it earlier using the mkdocs [linked preview tool](https://daringfireball.net/projects/markdown/dingus) and seemed ok, but you're right, I'll add the page too for clarity in a moment. I added the parent directory dots because the original link is broken, I have no way to test those though according to the mkdocs docs they "should" work OK. lmk.
ACyprus (Migrated from github.com) reviewed 2022-07-11 13:40:11 +02:00
docs/installing.md
ACyprus (Migrated from github.com) commented 2022-07-11 13:40:11 +02:00
Copy link

Yup, that's right. We could make it Installing#Include Profiles I guess. Other pages use such a format when they refer to a different page though.

What's your preference? Revert?

Yup, that's right. We could make it `Installing#Include Profiles` I guess. Other pages use such a format when they refer to a different page though. What's your preference? Revert?
alterNERDtive (Migrated from github.com) reviewed 2022-07-11 13:40:40 +02:00
docs/EliteAttack.md
alterNERDtive (Migrated from github.com) commented 2022-07-11 13:40:40 +02:00
Copy link

To be clear, your change does work. It’s just not … by the book, and will break if the site layout changes.

To be clear, your change does work. It’s just not … by the book, and will break if the site layout changes.
alterNERDtive (Migrated from github.com) reviewed 2022-07-11 13:42:17 +02:00
docs/installing.md
alterNERDtive (Migrated from github.com) commented 2022-07-11 13:42:17 +02:00
Copy link

Nah, just keep the change you did. Personally I don’t mind the # that much, but it doesn’t belong there.

Also fun fact, I thought clicking “resolve conversation” would submit the comment I wrote, but guess what …

Nah, just keep the change you did. Personally I don’t mind the `#` that much, but it doesn’t belong there. Also fun fact, I thought clicking “resolve conversation” would submit the comment I wrote, but guess what …
ACyprus (Migrated from github.com) reviewed 2022-07-11 13:44:53 +02:00
docs/EliteAttack.md
ACyprus (Migrated from github.com) commented 2022-07-11 13:44:53 +02:00
Copy link

Resolved by 7564176437

Resolved by https://github.com/alterNERDtive/VoiceAttack-profiles/pull/149/commits/75641764371a5661131b47222393894ef407f13e
ACyprus (Migrated from github.com) reviewed 2022-07-11 13:45:13 +02:00
docs/index.md
ACyprus (Migrated from github.com) commented 2022-07-11 13:45:13 +02:00
Copy link

Resolved by a0b4bd621f

Resolved by https://github.com/alterNERDtive/VoiceAttack-profiles/pull/149/commits/a0b4bd621ffc2dab8ff42b8162f54ddc509676e2
alterNERDtive (Migrated from github.com) requested changes 2022-07-11 13:45:59 +02:00
docs/EliteAttack.md
alterNERDtive (Migrated from github.com) commented 2022-07-11 13:45:45 +02:00
Copy link

The full line should read

that](configuration/EliteAttack.md#settings).

It’s not a relative link on the site, it’s the path to the Markdown file :)

The full line should read ``` that](configuration/EliteAttack.md#settings). ``` It’s not a relative link on the site, it’s the path to the Markdown file :)
ACyprus (Migrated from github.com) reviewed 2022-07-11 13:49:53 +02:00
docs/EliteAttack.md
ACyprus (Migrated from github.com) commented 2022-07-11 13:49:53 +02:00
Copy link

I'll get my coat... 9a916d5e78

I'll get my coat... https://github.com/alterNERDtive/VoiceAttack-profiles/pull/149/commits/9a916d5e78b219aead1fa608f15e1a728d523bee
ACyprus (Migrated from github.com) reviewed 2022-07-11 13:59:02 +02:00
docs/SpanshAttack.md
ACyprus (Migrated from github.com) commented 2022-07-11 13:59:02 +02:00
Copy link

ahaaa, I see. In that case, update using similar to the original for first and second lines:

fd5d8ef30b

ahaaa, I see. In that case, update using similar to the original for first and second lines: https://github.com/alterNERDtive/VoiceAttack-profiles/pull/149/commits/fd5d8ef30b8aa0f6f1762b7ccf4294c3437bcafc
alterNERDtive (Migrated from github.com) approved these changes 2022-07-11 14:06:48 +02:00
alterNERDtive commented 2022-07-11 14:06:56 +02:00 (Migrated from github.com)
Copy link

Top. I’ll go cherry-pick your commits later, first I need food. And then kids are back :)

Top. I’ll go cherry-pick your commits later, first I need food. And then kids are back :)
alterNERDtive commented 2022-07-11 19:49:10 +02:00 (Migrated from github.com)
Copy link

All cherry-picked into devel. Thanks!

All cherry-picked into `devel`. Thanks!

Pull request closed

Please reopen this pull request to perform a merge.
Sign in to join this conversation.
Reviewers
No reviewers
alterNERDtive
Labels
Clear labels   
EDDI

   
EliteAttack

   
RatAttack

   
SealAttack

   
SpanshAttack

   
StreamAttack

   
awaiting feedback

   
base

   
bug

Something isn't working

  
dependencies

Pull requests that update a dependency file

  
documentation

Improvements or additions to documentation

  
done

implemented, but not merged into release yet

  
duplicate

This issue or pull request already exists

  
enhancement

New feature or request

  
invalid

This doesn't seem right

  
wontfix

This will not be worked on

No labels
EDDI
EliteAttack
RatAttack
SealAttack
SpanshAttack
StreamAttack
awaiting feedback
base
bug
dependencies
documentation
done
duplicate
enhancement
invalid
wontfix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: EliteDangerous/VoiceAttack-profiles#149
No description provided.
Delete branch "devel"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?