Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes/updates for AI Conceptual docs #40848

Closed

Conversation

jmatthiesen
Copy link
Contributor

@jmatthiesen jmatthiesen commented May 10, 2024

Summary

WORK IN-PROGRESS:
Collecting updates to the new conceptual AI docs as part of a team "docs bash".

Fixes included:

  • Fixed broken links on tokens doc, simplifying text

Internal previews

Toggle expand/collapse
📄 File 🔗 Preview link
docs/ai/conceptual/embeddings.md Embeddings in .NET
docs/core/compatibility/core-libraries/6.0/filestream-position-updates-after-readasync-writeasync-completion.md ".NET 6 breaking change: FileStream.Position updated after ReadAsync or WriteAsync completion"
docs/core/deploying/trimming/trimming-options.md Trimming options
docs/core/install/linux-package-mixup.md Troubleshoot .NET errors related to missing files on Linux
docs/core/install/linux-ubuntu-install.md [.NET 8](https://review.learn.microsoft.com/en-us/dotnet/core/install/linux-ubuntu-install?branch=pr-en-us-40848)
docs/core/install/linux-ubuntu.md Get OS version info
docs/core/project-sdk/msbuild-props-desktop.md docs/core/project-sdk/msbuild-props-desktop
docs/core/project-sdk/overview.md .NET project SDKs
docs/core/testing/unit-testing-mstest-sdk.md MSTest SDK overview
docs/core/tools/sdk-errors/netsdk1022.md NETSDK1022: Duplicate items were included
docs/core/whats-new/dotnet-9/runtime.md docs/core/whats-new/dotnet-9/runtime
docs/core/whats-new/dotnet-9/sdk.md What's new in the SDK for .NET 9
docs/csharp/language-reference/configure-language-version.md Configure C# language version - C# Guide
docs/csharp/tour-of-csharp/overview.md A tour of the C# language
docs/framework/get-started/system-requirements.md .NET Framework system requirements
docs/framework/migration-guide/versions-and-dependencies.md docs/framework/migration-guide/versions-and-dependencies
docs/framework/release-notes/2024/04-09-april-security-and-quality-rollup.md April 2024 security and quality rollup
docs/framework/windows-services/how-to-install-and-uninstall-services.md How to: Install and uninstall Windows services
docs/framework/windows-services/how-to-log-information-about-services.md "How to: Log Information About Services"
docs/framework/windows-services/how-to-write-services-programmatically.md How to: Write Services Programmatically
docs/framework/windows-services/service-application-programming-architecture.md Service Application Programming Architecture
docs/framework/windows-services/walkthrough-creating-a-windows-service-application-in-the-component-designer.md docs/framework/windows-services/walkthrough-creating-a-windows-service-application-in-the-component-designer
docs/fundamentals/code-analysis/code-style-rule-options.md Code-style rule options
docs/fundamentals/code-analysis/quality-rules/ca1065.md CA1065: Do not raise exceptions in unexpected locations
docs/fundamentals/code-analysis/quality-rules/index.md Code quality rules overview
docs/standard/base-types/regular-expression-source-generators.md .NET regular expression source generators
docs/standard/exceptions/best-practices-for-exceptions.md docs/standard/exceptions/best-practices-for-exceptions
docs/standard/io/how-to-read-text-from-a-file.md Read text from a file
docs/standard/native-interop/best-practices.md Native interoperability best practices - .NET
docs/whats-new/dotnet-docs-mod1.md .NET docs: What's new for April 2024

Note
This table shows preview links for the 30 files with the most changes. For preview links for other files in this PR, select OpenPublishing.Build Details within checks.

Clockwork-Muse and others added 30 commits April 15, 2024 16:56
Summary
* Microsoft package repository:
  - stops shipping .NET staring with Ubuntu 24.04 (see dotnet/core#9258)
* .NET backports package repository (https://launchpad.net/~dotnet/+archive/ubuntu/backports):
  - add support information
  - list supported versions
  - add (un)install instructions
  - add & change troubleshooting instructions
* Update outdated ARM information
* Update IBM System Z platform support infromation
* Update Dependencies:
  - add ca-certificates (see https://bugs.launchpad.net/ubuntu/+source/dotnet6/+bug/2057982 & dotnet/sdk#39544)
  - change libicu to version 74 for Ubuntu 24.04+ (see https://launchpad.net/ubuntu/noble/+source/icu)
* Fix typo in cross-platform-cryptography.md

I believe given the context, the sentence:

> As **authentication** encryption requires ...

Should read:

> As **authenticated** encryption requires ...

It may be worth going further and changing "As" to "Since" so it reads:

> **Since authenticated** encryption requires ...

...but I defer to the PR reviewers on that extra tweak.

* Apply suggestions from code review

---------

Co-authored-by: David Pine <david.pine@microsoft.com>
Fix link for `editorconfig` template row
This change will make that the expected behavior starts working as described
* update for Xamarin archive

Replace /xamarin with /maui

* Remove xamarin in prep for achival

As Xamarin products are delisted, don't recommend them.
…ve-update.md

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
…ve-update.md

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
…ve-update.md

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
…ve-update.md

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
…ve-update.md

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
…ve-update.md

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
Co-authored-by: Jan Kotas <jkotas@microsoft.com>
azure-sdk and others added 13 commits May 9, 2024 01:17
The description of variable capture was a bit confusing; the local function won't be emitted as a delegate type here. However, it will use a closure, just like delegate types do, so I've updated the wording to reflect that.
fixed minor syntax for yield snippet
* Convert DllImport uses to LibraryImport

There are several places where DllImport remains.
This is due to the nature of some of the documentation
and how it is intended to be consumed.

* Update to .NET 8 TFM.

---------
Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
Co-authored-by: Rich Lander <rlander@microsoft.com>
Co-authored-by: Elinor Fung <elfung@microsoft.com>
* Rewrite samples; update links & minor text

* add prereqs; move file note

* md
* Update import-declarations-the-open-keyword.md

Chapter on global keyword

* better names

* specifier not keyword

* Update import-declarations-the-open-keyword.md

Co-authored-by: Petr <psfinaki@users.noreply.github.com>

* Update import-declarations-the-open-keyword.md

Co-authored-by: Petr <psfinaki@users.noreply.github.com>

* try fix md linting errors

---------

Co-authored-by: Petr <psfinaki@users.noreply.github.com>
@jmatthiesen jmatthiesen self-assigned this May 10, 2024
@dotnet-bot dotnet-bot added this to the May 2024 milestone May 10, 2024
@@ -33,8 +33,6 @@ This text could be tokenized as:
- a
- cat

The model will add only the first occurrence of the "a" token to its vocabulary. All other occurrences can be represented by that first token.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed this line to simplify the section since it wasn't core to it and it is also described later in the doc with the example given for adding IDs to tokens.

jmatthiesen and others added 12 commits May 10, 2024 14:29
* add example for order of execution

* used wrong reference

* not sure for what purpose this identifier is used but adjust it so it fits the format of the other examples
* AI - chat refresh

* Update docs/ai/get-started-app-chat-template.md

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>

* Update docs/ai/get-started-app-chat-template.md

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>

---------

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
* Add note about collection expressions.

Fixes #38712

Note that these examples all use collection expressions.

* Update docs/csharp/language-reference/builtin-types/arrays.md

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>

* show both examples in note.

---------

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
OpenStreamAsync => OpenOutboundStreamAsync
AcceptStreamAsync => AcceptInboundStreamAsync
@jmatthiesen jmatthiesen deleted the u/jmatthiesen/aiConceptualDocFixes branch May 14, 2024 16:37
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.

None yet