Merge remote-tracking branch 'upstream/main'

Author: momo773510

CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# Contribute to CppDoc
+
+## Migrate a page from cppreference to CppDoc
+
+We're now in the process of migrating contents from [cppreference] to CppDoc. Please checkout our [migration guide](https://cppdoc.cc/development/migration) for guidelines.
+
+## Report a documentation bug
+
+We use GitHub issues to track documentation bugs. To report a bug, please [opening a new GitHub issue](https://github.com/cppdoc-cc/cppdoc/issues/new).
+
+## Add new content
+
+> [!NOTE]
+> Incomplete.

README.md

@@ -36,6 +36,8 @@ You can report a bug or request a new feature by [opening a new GitHub issue](ht
 
 If you have made some changes, you can [open a new GitHub pull request](https://github.com/cppdoc-cc/cppdoc/compare).
 
+For more information on contributing to CppDoc, please refer to our [contribution guide](./CONTRIBUTING.md).
+
 ## License
 
 The content of the documentation is licensed under the [Creative Commons Attribution-ShareAlike 4.0 International license](./LICENSE.CC-BY-SA-4.0) and the [GNU Free Documentation License](./LICENSE.GFDL). The underlying source code used to process, format, and display that content is licensed under the [MIT license](./LICENSE.MIT).

astro.config.mjs

@@ -10,6 +10,7 @@ import starlightHeadingBadges from "starlight-heading-badges";
 export default defineConfig({
   site: process.env.CPPDOC_SITE,
   base: process.env.CPPDOC_BASE,
+  trailingSlash: "always",
   integrations: [
     starlight({
       title: "CppDoc",

ec.config.mjs

@@ -0,0 +1,7 @@
+// @ts-check
+import { pluginCxxMark } from "./src/plugins/expressive-code/cxx-mark.ts";
+
+/** @type {import('@astrojs/starlight/expressive-code').StarlightExpressiveCodeOptions} */
+export default {
+  plugins: [pluginCxxMark()],
+};

migrate/PROMPT.md

@@ -4,7 +4,7 @@ You are a professional C++ documentation writer. You are now migrating cpprefere
 3. For links, take the URL part, remove `/w/` and the latter part `.html`, and then wrap it with `DocLink`. For example:
 If the current path is: `/w/cpp/language/basics.html`
 Link: `<a href="declarations.html" title="cpp/language/declarations">declarations</a>`
-You should, based on the current link, change it to: `<DocLink src="/cpp/language/declarations">declarations</DocLink>`
+You should, based on the current link, change it to: `<DocLink dest="/cpp/language/declarations">declarations</DocLink>`
 4. Currently available components:
 ```mdx
 {{LLM_DOCS}}

migrate/migrate-bot.ts

@@ -418,6 +418,7 @@ ${imageUrl ? `![Text Diff](${imageUrl})` : "(No text diff image)"}
     body: prBody,
     head: branchName,
     base: "main",
+    draft: true,
   });
 
   console.log(`Created PR #${pr.number}`);

migrate/slug_map.json

@@ -10115,6 +10115,10 @@
     "cppref": "cpp/utility/in_range",
     "cppdoc": "cpp/library/utility/in_range"
   },
+  {
+    "cppref": "cpp/utility/rtti",
+    "cppdoc": "cpp/library/utility/rtti"
+  },
   {
     "cppref": "cpp/utility/program",
     "cppdoc": "cpp/library/utility/program"
@@ -22115,6 +22119,134 @@
     "cppref": "c/header",
     "cppdoc": "c/library/header"
   },
+  {
+    "cppref": "c/header/assert",
+    "cppdoc": "c/library/headers/assert"
+  },
+  {
+    "cppref": "c/header/complex",
+    "cppdoc": "c/library/headers/complex"
+  },
+  {
+    "cppref": "c/header/ctype",
+    "cppdoc": "c/library/headers/ctype"
+  },
+  {
+    "cppref": "c/header/errno",
+    "cppdoc": "c/library/headers/errno"
+  },
+  {
+    "cppref": "c/header/fenv",
+    "cppdoc": "c/library/headers/fenv"
+  },
+  {
+    "cppref": "c/header/float",
+    "cppdoc": "c/library/headers/float"
+  },
+  {
+    "cppref": "c/header/inttypes",
+    "cppdoc": "c/library/headers/inttypes"
+  },
+  {
+    "cppref": "c/header/iso646",
+    "cppdoc": "c/library/headers/iso646"
+  },
+  {
+    "cppref": "c/header/limits",
+    "cppdoc": "c/library/headers/limits"
+  },
+  {
+    "cppref": "c/header/locale",
+    "cppdoc": "c/library/headers/locale"
+  },
+  {
+    "cppref": "c/header/math",
+    "cppdoc": "c/library/headers/math"
+  },
+  {
+    "cppref": "c/header/setjmp",
+    "cppdoc": "c/library/headers/setjmp"
+  },
+  {
+    "cppref": "c/header/signal",
+    "cppdoc": "c/library/headers/signal"
+  },
+  {
+    "cppref": "c/header/stdalign",
+    "cppdoc": "c/library/headers/stdalign"
+  },
+  {
+    "cppref": "c/header/stdarg",
+    "cppdoc": "c/library/headers/stdarg"
+  },
+  {
+    "cppref": "c/header/stdatomic",
+    "cppdoc": "c/library/headers/stdatomic"
+  },
+  {
+    "cppref": "c/header/stdbit",
+    "cppdoc": "c/library/headers/stdbit"
+  },
+  {
+    "cppref": "c/header/stdbool",
+    "cppdoc": "c/library/headers/stdbool"
+  },
+  {
+    "cppref": "c/header/stdckdint",
+    "cppdoc": "c/library/headers/stdckdint"
+  },
+  {
+    "cppref": "c/header/stddef",
+    "cppdoc": "c/library/headers/stddef"
+  },
+  {
+    "cppref": "c/header/stdint",
+    "cppdoc": "c/library/headers/stdint"
+  },
+  {
+    "cppref": "c/header/stdio",
+    "cppdoc": "c/library/headers/stdio"
+  },
+  {
+    "cppref": "c/header/stdlib",
+    "cppdoc": "c/library/headers/stdlib"
+  },
+  {
+    "cppref": "c/header/stdmchar",
+    "cppdoc": "c/library/headers/stdmchar"
+  },
+  {
+    "cppref": "c/header/stdnoreturn",
+    "cppdoc": "c/library/headers/stdnoreturn"
+  },
+  {
+    "cppref": "c/header/string",
+    "cppdoc": "c/library/headers/string"
+  },
+  {
+    "cppref": "c/header/tgmath",
+    "cppdoc": "c/library/headers/tgmath"
+  },
+  {
+    "cppref": "c/header/threads",
+    "cppdoc": "c/library/headers/threads"
+  },
+  {
+    "cppref": "c/header/time",
+    "cppdoc": "c/library/headers/time"
+  },
+  {
+    "cppref": "c/header/uchar",
+    "cppdoc": "c/library/headers/uchar"
+  },
+  {
+    "cppref": "c/header/wchar",
+    "cppdoc": "c/library/headers/wchar"
+  },
+  {
+    "cppref": "c/header/wctype",
+    "cppdoc": "c/library/headers/wctype"
+  },
   {
     "cppref": "c/locale",
     "cppdoc": "c/library/locale"
@@ -24499,6 +24631,22 @@
     "cppref": "cpp/identifier_with_special_meaning/override",
     "cppdoc": "cpp/language/keywords/override"
   },
+  {
+    "cppref": "cpp/identifier_with_special_meaning/pre",
+    "cppdoc": "cpp/language/keywords/pre"
+  },
+  {
+    "cppref": "cpp/identifier_with_special_meaning/post",
+    "cppdoc": "cpp/language/keywords/post"
+  },
+  {
+    "cppref": "cpp/identifier_with_special_meaning/trivially_relocatable_if_eligible",
+    "cppdoc": "cpp/language/keywords/trivially_relocatable_if_eligible"
+  },
+  {
+    "cppref": "cpp/identifier_with_special_meaning/replaceable_if_eligible",
+    "cppdoc": "cpp/language/keywords/replaceable_if_eligible"
+  },
   {
     "cppref": "cpp/identifier_with_special_meaning/module",
     "cppdoc": "cpp/language/keywords/module"
@@ -24651,6 +24799,10 @@
     "cppref": "cpp/language/modules",
     "cppdoc": "cpp/language/basic_concepts/modules"
   },
+  {
+    "cppref": "cpp/language/contracts",
+    "cppdoc": "cpp/language/basic_concepts/contracts"
+  },
   {
     "cppref": "cpp/language/copy_initialization",
     "cppdoc": "cpp/language/initialization/copy_initialization"

migrate/update-migrate-progress.ts

@@ -47,11 +47,11 @@ function generateUrls(
 function generateMarkdown(status: EntryStatus): string {
   const { entry, migrated, cpprefUrl, cppdocUrl, issueUrl } = status;
   if (migrated) {
-    return `| ✅ | [cppref](${cpprefUrl}) | [cppdoc](${cppdocUrl}) | \`${entry}\` | `;
+    return `| ✅ | [cppref](${cpprefUrl}) | [cppdoc](${cppdocUrl}) | \`${entry.cppdoc ?? entry.cppref + "(cppref)"}\` | `;
   } else {
     return `| ❌ | [cppref](${cpprefUrl}) | ${
       entry.cppdoc ? `[create](${issueUrl})` : "N/A"
-    } |  \`${entry}\` |`;
+    } |  \`${entry.cppdoc ?? entry.cppref + "(cppref)"}\` |`;
   }
 }
 

src/assets/examples/development/guide/cxx-mark-1.mdx

@@ -0,0 +1,8 @@
+```cpp cxx-mark
+// syntax of for statement
+/*$s:attr*//*$opt*/ for ( /*$s:init-statement*/ /*$s:condition*//*$opt*/ ; /*$s:expression*//*$opt*/ ) /*$s:statement*/
+
+// exposition only alias template of conditionally const type
+template< bool Const, class T >
+using /*$e:maybe-const*/ = std::conditional_t<Const, const T, T>;
+```

src/components/DocLink.astro

@@ -1,24 +1,24 @@
 ---
-import { getLinkToKey } from "../lib/doc-index";
+import { isLinkMissing, normalizeLink } from "../lib/doc-link";
 
 interface Props {
-  src: string;
+  dest: string;
+  section?: string;
 }
 
-const { src } = Astro.props;
-const rawLink = await getLinkToKey(src);
+const { dest, section } = Astro.props;
 
-const missing = rawLink === undefined;
-const link = rawLink ?? "";
+const missing = await isLinkMissing(dest);
+const link = normalizeLink(dest) + (section ? "#" + section : "");
 ---
 
 {
   missing ? (
-    <span class="doc-link missing" title={`${src} (missing)`}>
+    <span class="doc-link missing" title={`${dest} (missing)`}>
       <slot />
     </span>
   ) : (
-    <a class="doc-link" href={link} title={src}>
+    <a class="doc-link" href={link} title={dest}>
       <slot />
     </a>
   )