build based on 0e01776

lucaferranti · Oct 21, 2024 · abd8251 · abd8251
1 parent 74d170a
commit abd8251
Show file tree

Hide file tree

Showing 20 changed files with 1,250 additions and 0 deletions.
diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json
@@ -0,0 +1 @@
+{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-10-21T19:50:46","documenter_version":"1.7.0"}}
diff --git a/dev/90-contributing/index.html b/dev/90-contributing/index.html
@@ -0,0 +1,2 @@
+<!DOCTYPE html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Contributor&#39;s guide · DedekindCutArithmetic.jl</title><meta name="title" content="Contributor&#39;s guide · DedekindCutArithmetic.jl"/><meta property="og:title" content="Contributor&#39;s guide · DedekindCutArithmetic.jl"/><meta property="twitter:title" content="Contributor&#39;s guide · DedekindCutArithmetic.jl"/><meta name="description" content="Documentation for DedekindCutArithmetic.jl."/><meta property="og:description" content="Documentation for DedekindCutArithmetic.jl."/><meta property="twitter:description" content="Documentation for DedekindCutArithmetic.jl."/><meta property="og:url" content="https://lucaferranti.github.io/DedekindCutArithmetic.jl/90-contributing/"/><meta property="twitter:url" content="https://lucaferranti.github.io/DedekindCutArithmetic.jl/90-contributing/"/><link rel="canonical" href="https://lucaferranti.github.io/DedekindCutArithmetic.jl/90-contributing/"/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">DedekindCutArithmetic.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li><a class="tocitem" href="../tutorial/">Tutorial</a></li><li><a class="tocitem" href="../api/">API</a></li><li><input class="collapse-toggle" id="menuitem-4" type="checkbox" checked/><label class="tocitem" for="menuitem-4"><span class="docs-label">Contributing</span><i class="docs-chevron"></i></label><ul class="collapsed"><li class="is-active"><a class="tocitem" href>Contributor&#39;s guide</a><ul class="internal"><li><a class="tocitem" href="#Discussions"><span>Discussions</span></a></li><li><a class="tocitem" href="#Opening-issues"><span>Opening issues</span></a></li><li><a class="tocitem" href="#Opening-pull-requests"><span>Opening pull requests</span></a></li></ul></li><li><a class="tocitem" href="../91-developer/">Developer documentation</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Contributing</a></li><li class="is-active"><a href>Contributor&#39;s guide</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Contributor&#39;s guide</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/lucaferranti/DedekindCutArithmetic.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/lucaferranti/DedekindCutArithmetic.jl/blob/main/docs/src/90-contributing.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="contributing"><a class="docs-heading-anchor" href="#contributing">Contributor&#39;s guide</a><a id="contributing-1"></a><a class="docs-heading-anchor-permalink" href="#contributing" title="Permalink"></a></h1><p>First of all, huge thanks for your interest in the package! ✨</p><p>This page has some tips and guidelines on how to contribute.</p><p>We welcome all kinds of contribution, including, but not limited to code, documentation, examples, bug reports, feature requests etc.</p><p>All interactions should folow the <a href="https://github.com/lucaferranti/DedekindCutArithmetic.jl/blob/main/CODE_OF_CONDUCT.md">Code of Conduct</a>. In a nutshell, be polite and respectful.</p><div class="admonition is-success"><header class="admonition-header">Tip</header><div class="admonition-body"><p>Feel free to ping us after a few days if there are no responses.</p></div></div><h2 id="Discussions"><a class="docs-heading-anchor" href="#Discussions">Discussions</a><a id="Discussions-1"></a><a class="docs-heading-anchor-permalink" href="#Discussions" title="Permalink"></a></h2><p>If you need help using <code>DedekindCutArithmetic.jl</code>, you can use the <a href="https://github.com/lucaferranti/DedekindCutArithmetic.jl/discussions/categories/helpdesk">helpdesk</a> category to ask for help. This is preferable over issues, which are meant for bugs and feature requests, because discussions do not get closed once fixed and remain browsable for others.</p><p>There is also a <a href="https://github.com/lucaferranti/DedekindCutArithmetic.jl/discussions/categories/show-and-tell">show and tell</a> category to share with the world your work using DedekindCutArithmetic.jl. If your work involves a new application of <code>DedekindCutArithmetic.jl</code> and you also want it featured in the Applications section in the documentation, let us know (in the element chat or in an issue). You will get help with the workflow and setup, but you are expected to do the writing 😃 .</p><h2 id="Opening-issues"><a class="docs-heading-anchor" href="#Opening-issues">Opening issues</a><a id="Opening-issues-1"></a><a class="docs-heading-anchor-permalink" href="#Opening-issues" title="Permalink"></a></h2><p>If you think you found a bug, feel free to open an <a href="https://github.com/lucaferranti/DedekindCutArithmetic.jl/issues">issue</a>. Issues to suggest new features are welcome too.</p><h2 id="Opening-pull-requests"><a class="docs-heading-anchor" href="#Opening-pull-requests">Opening pull requests</a><a id="Opening-pull-requests-1"></a><a class="docs-heading-anchor-permalink" href="#Opening-pull-requests" title="Permalink"></a></h2><p>We follow the <a href="https://github.com/SciML/ColPrac">ColPrac guide for collaborative practices</a>. New contributors should make sure to read that guide before opening their first pull request.</p><p>If you found an issue that interests you, comment on that issue what your plans are. If the solution to the issue is clear, you can immediately create a pull request. Otherwise, say what yourfollow proposed solution is and wait for a discussion around it.</p><p>For small changes (typos, trivial bug fixes) it is ok to open a PR directly even without an associated issue. For non-trivial changes, please open an issue first.</p><p>More technical details and tips on how work with git, run tests, build documentation etc. can be found in the <a href="../91-developer/">developer&#39;s guide</a>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../api/">« API</a><a class="docs-footer-nextpage" href="../91-developer/">Developer documentation »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Monday 21 October 2024 19:50">Monday 21 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>