Skip to content

Updated images to new docs standard for Windows#7276

Merged
Jjagg merged 3 commits intoMonoGame:developfrom
SimonDarksideJ:dev/image_update
Aug 5, 2020
Merged

Updated images to new docs standard for Windows#7276
Jjagg merged 3 commits intoMonoGame:developfrom
SimonDarksideJ:dev/image_update

Conversation

@SimonDarksideJ
Copy link
Copy Markdown
Contributor

Updated images to new docs standard for Windows.

Additional tasks:

  • Update code docs to 3.8 standards
  • removed any lingering "pipeline" references
  • Removed redundant pipeline images

Additional tasks:

* Update code docs to 3.8 standards
* removed any lingering "pipeline" references
* Removed redundant pipeline images
![Adding TTF fonts step 2](~/images/adding_ttf_fonts_step_2.PNG)

1. Open the newly created .spritefont file in your text editor of choice, find this line and change it to your selected .ttf font.
2. Open the newly created .spritefont file in your text editor of choice, find this line and change it to your selected .ttf font.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please leave this at 1. The markdown renderer automatically sets the right numbers in numbered lists, so conventions often use 1 for all entries in a list so things can be reordered/added/deleted without issue. We should probably have a style guide. I use the MS doc extension for vs code which is great to standardize formatting in md files and detect issues.

You can see the list is correct in the rendered file: https://docs.monogame.net/articles/content/adding_ttf_fonts.html

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apologies for the delay, sorted now @Jjagg

@SimonDarksideJ SimonDarksideJ requested a review from Jjagg August 5, 2020 23:24
![Open Content](~/images/getting_started/3_open_content.png)

You should now see the Pipeline Editor window open up. If it does not open up (you see a text file open), then you can right-click on **Content.mgcb** and select **Open With**, then select **MonoGame Pipeline** in the list, click **Set as Default** and then click **OK**.
You should now see the MGCB Editor window open up. If it does not open up (you see a text file open), then you can right-click on **Content.mgcb** and select **Open With**, then select **mgcb-editor-wpf** in the list, click **Set as Default** and then click **OK**.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, this is not a very friendly name. I think we should be able to change this, but I don't know how VS picks this.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You mean mgcb-editor-wpf ?

@harry-cpp ?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well if you can change it, then that PR should also update the name in the docs, shouldn't affect this PR.

Should be raised as a separate issue if need be (I agree, it's a crap name, seems to be based on the .NET project name maybe?)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's the assembly name and the executable name.

Copy link
Copy Markdown
Contributor

@jnoyola jnoyola Aug 6, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My initial thought when organizing those assemblies was that each platform's executable could be in a subfolder, allowing them all to be named mgcb-editor, but then all supporting assemblies, templates, etc. would have to be duplicated in each platform's subfolder. I couldn't think of a clean way to do this so I just gave them unique names so they could live in the same main folder.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, we shouldn't change that, just need a way to set the name as it appears in VS. If it's the executable name we can create a shortcut and register that in the Windows registry. Can we reuse the link from the start menu (#7223)?

Copy link
Copy Markdown
Contributor

@Jjagg Jjagg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good!

@Jjagg Jjagg merged commit 0c16538 into MonoGame:develop Aug 5, 2020
@SimonDarksideJ SimonDarksideJ deleted the dev/image_update branch August 5, 2020 23:48
kimimaru4000 pushed a commit to kimimaru4000/MonoGame that referenced this pull request Sep 25, 2020
* Updated images to new docs standard.

Additional tasks:

* Update code docs to 3.8 standards
* removed any lingering "pipeline" references
* Removed redundant pipeline images
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants