<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][13501] trunk: Add a `/docs` directory to provide User and Developer documentation</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/13501">13501</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/13501","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>imath</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-06-10 10:02:48 +0000 (Sat, 10 Jun 2023)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Add a `/docs` directory to provide User and Developer documentation
Just like the WordPress REST API or Gutenberg did, we are now using our GitHub repository `/docs` directory to contribute to User and Developer documentation.
This commit inaugurate this new space with some documentation pages and assets.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/8897">#8897</a>
Closes https://github.com/buddypress/buddypress/pull/102</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkgithubworkflowsunittestsyml">trunk/.github/workflows/unit-tests.yml</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li>trunk/docs/</li>
<li>trunk/docs/developer/</li>
<li><a href="#trunkdocsdeveloperREADMEmd">trunk/docs/developer/README.md</a></li>
<li>trunk/docs/developer/introduction/</li>
<li><a href="#trunkdocsdeveloperintroductionREADMEmd">trunk/docs/developer/introduction/README.md</a></li>
<li><a href="#trunkdocsdevelopermanifestjson">trunk/docs/developer/manifest.json</a></li>
<li>trunk/docs/user/</li>
<li><a href="#trunkdocsuserREADMEmd">trunk/docs/user/README.md</a></li>
<li>trunk/docs/user/administration/</li>
<li><a href="#trunkdocsuseradministrationREADMEmd">trunk/docs/user/administration/README.md</a></li>
<li>trunk/docs/user/administration/settings/</li>
<li><a href="#trunkdocsuseradministrationsettingsREADMEmd">trunk/docs/user/administration/settings/README.md</a></li>
<li><a href="#trunkdocsuseradministrationsettingsurlsmd">trunk/docs/user/administration/settings/urls.md</a></li>
<li>trunk/docs/user/administration/tools/</li>
<li><a href="#trunkdocsuseradministrationtoolsREADMEmd">trunk/docs/user/administration/tools/README.md</a></li>
<li><a href="#trunkdocsuseradministrationtoolsrepairmd">trunk/docs/user/administration/tools/repair.md</a></li>
<li>trunk/docs/user/assets/</li>
<li><a href="#trunkdocsuserassetsbpsettingscustomizeslugspng">trunk/docs/user/assets/bp-settings-customize-slugs.png</a></li>
<li><a href="#trunkdocsuserassetsbptoolsresetslugspng">trunk/docs/user/assets/bp-tools-reset-slugs.png</a></li>
<li><a href="#trunkdocsusermanifestjson">trunk/docs/user/manifest.json</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkgithubworkflowsunittestsyml"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/.github/workflows/unit-tests.yml</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/.github/workflows/unit-tests.yml 2023-06-10 06:22:42 UTC (rev 13500)
+++ trunk/.github/workflows/unit-tests.yml 2023-06-10 10:02:48 UTC (rev 13501)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2,8 +2,12 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> on:
</span><span class="cx" style="display: block; padding: 0 10px"> pull_request:
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ paths-ignore:
+ - 'docs/**'
</ins><span class="cx" style="display: block; padding: 0 10px"> push:
</span><span class="cx" style="display: block; padding: 0 10px"> branches: [ master ]
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ paths-ignore:
+ - 'docs/**'
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> jobs:
</span><span class="cx" style="display: block; padding: 0 10px"> tests:
</span></span></pre></div>
<a id="trunkdocsdeveloperREADMEmd"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/docs/developer/README.md</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/developer/README.md (rev 0)
+++ trunk/docs/developer/README.md 2023-06-10 10:02:48 UTC (rev 13501)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,7 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+# BuddyPress Add-ons Handbook
+
+_Welcome to the BuddyPress Add-ons Developer Handbook; are you ready to jump right in to the world of BuddyPress Add-ons?_
+
+The Add-ons Developer Handbook is a resource for all things BuddyPress Add-ons. Whether you’re new to BuddyPress Add-ons development, or you’re an experienced Add-ons developer, you should be able to find the answer to many of your Add-on-related questions right here.
+
+If you’re new to Add-on development, start by reading the [introduction](./introduction/README.md).
</ins></span></pre></div>
<a id="trunkdocsdeveloperintroductionREADMEmd"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/docs/developer/introduction/README.md</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/developer/introduction/README.md (rev 0)
+++ trunk/docs/developer/introduction/README.md 2023-06-10 10:02:48 UTC (rev 13501)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,13 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+# Introduction
+
+BuddyPress Add-ons are WordPress plugins extending BuddyPress with new features. If you're new to WordPress plugin development, you should probably have a look to the [official WordPress Plugin development handbook](https://developer.wordpress.org/plugins/).
+
+## Why we make BuddyPress Add-ons?
+
+A very important rule in BuddyPress development is: __do not edit BuddyPress core__. As the BuddyPress plugin is overwritten each time it is updated to a new version, locally edited BuddyPress core files would also be overwritten. Thankfully, WordPress provides a powerful Plugin API we can use to extend, reduce or change the behavior of almost every BP features.
+
+The BuddyPress core team [has decided](https://buddypress.org/2023/05/lets-better-organize-the-buddypress-plugin/) to use Add-ons to better organize the BuddyPress plugin moving optional components into specific Add-ons users can download and activate separately. We believe doing so will bring more freedom to everyone:
+
+- More freedom to end-users as they can choose to use alternate components built by third party plugin authors.
+- More freedom to plugin authors as they can challenge features built & maintained by the BuddyPress Core team.
+- More freedom to BuddyPress Core developers as they can build great features without worrying a third party plugin author might have built it already.
</ins></span></pre></div>
<a id="trunkdocsdevelopermanifestjson"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/docs/developer/manifest.json</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/developer/manifest.json (rev 0)
+++ trunk/docs/developer/manifest.json 2023-06-10 10:02:48 UTC (rev 13501)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,14 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+[
+ {
+ "title": "Add-ons Handbook",
+ "slug": "handbook",
+ "markdown_source": "../developer/README.md",
+ "parent": null
+ },
+ {
+ "title": "Introduction to Add-ons development",
+ "slug": "introduction",
+ "markdown_source": "../developer/introduction/README.md",
+ "parent": null
+ }
+]
</ins></span></pre></div>
<a id="trunkdocsuserREADMEmd"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/docs/user/README.md</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/user/README.md (rev 0)
+++ trunk/docs/user/README.md 2023-06-10 10:02:48 UTC (rev 13501)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,5 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+# User Handbook
+
+Welcome to the BuddyPress User Handbook.
+
+- [BuddyPress Administration](./administration/README.md)
</ins></span></pre></div>
<a id="trunkdocsuseradministrationREADMEmd"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/docs/user/administration/README.md</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/user/administration/README.md (rev 0)
+++ trunk/docs/user/administration/README.md 2023-06-10 10:02:48 UTC (rev 13501)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,10 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+# BuddyPress Administration
+
+BuddyPress Administration happens inside your WordPress Dashboard. BuddyPress adds custom menus and/or sub menus to let you customize your site's community area as well as moderate the content your members created. Below are top level Dashboard menus from where you'll be able to administrate BuddyPress.
+
+- [Settings](./settings/README.md)
+- [Tools](./tools/README.md)
+- Users
+- Activity
+- Groups
+- Emails
</ins></span></pre></div>
<a id="trunkdocsuseradministrationsettingsREADMEmd"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/docs/user/administration/settings/README.md</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/user/administration/settings/README.md (rev 0)
+++ trunk/docs/user/administration/settings/README.md 2023-06-10 10:02:48 UTC (rev 13501)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,7 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+# BuddyPress Settings
+
+BuddyPress Settings are reachable from the BuddyPress' Settings submenu. From there you can manage BP Components, BP URLs and BP Options.
+
+- Components
+- [URLs](urls.md)
+- Options
</ins></span></pre></div>
<a id="trunkdocsuseradministrationsettingsurlsmd"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/docs/user/administration/settings/urls.md</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/user/administration/settings/urls.md (rev 0)
+++ trunk/docs/user/administration/settings/urls.md 2023-06-10 10:02:48 UTC (rev 13501)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,5 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+# BuddyPress URLs settings
+
+Since version 12.0 of BuddyPress, you can now customize all URLs the plugin is generating to display your community content. An important change to note: BuddyPress directory pages are no longer regular WordPress pages and customizing these directory titles or URLs as well as any other BP URLs is only possible from the URLs tab of the BuddyPress settings Administration screen.
+
+
</ins></span></pre></div>
<a id="trunkdocsuseradministrationtoolsREADMEmd"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/docs/user/administration/tools/README.md</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/user/administration/tools/README.md (rev 0)
+++ trunk/docs/user/administration/tools/README.md 2023-06-10 10:02:48 UTC (rev 13501)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,7 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+# BuddyPress Administration Tools
+
+BuddyPress Tools are reachable from the BuddyPress' Toold submenu. From there you can use various tools to repair or manage specific features.
+
+- [Repair](./repair.md)
+- Manage Invitations
+- Manage Opt-outs
</ins></span></pre></div>
<a id="trunkdocsuseradministrationtoolsrepairmd"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/docs/user/administration/tools/repair.md</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/user/administration/tools/repair.md (rev 0)
+++ trunk/docs/user/administration/tools/repair.md 2023-06-10 10:02:48 UTC (rev 13501)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,9 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+# BuddyPress repair tool
+
+This is the first BuddyPress tool, it helps you perform some reparations when your BuddyPress relationships are out of sync or some other bulk operations.
+
+## Reset all BP URLs to their default values
+
+Since version 12.0 of BuddyPress, you can customize all URLs the plugin is generating. If for some reasons, you need to come back to the way there was before you customized them, you can use this tool.
+
+
</ins></span></pre></div>
<a id="trunkdocsuserassetsbpsettingscustomizeslugspng"></a>
<div class="binary"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/docs/user/assets/bp-settings-customize-slugs.png</h4>
<pre class="diff"><span>
<span class="cx">(Binary files differ)
</span></span></pre></div>
<span class="cx" style="display: block; padding: 0 10px">Index: trunk/docs/user/assets/bp-settings-customize-slugs.png
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- trunk/docs/user/assets/bp-settings-customize-slugs.png 2023-06-10 06:22:42 UTC (rev 13500)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ trunk/docs/user/assets/bp-settings-customize-slugs.png 2023-06-10 10:02:48 UTC (rev 13501)
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/docs/user/assets/bp-settings-customize-slugs.png
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span><a id="svnmimetype"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:mime-type</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+image/png
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunkdocsuserassetsbptoolsresetslugspng"></a>
<div class="binary"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/docs/user/assets/bp-tools-reset-slugs.png</h4>
<pre class="diff"><span>
<span class="cx">(Binary files differ)
</span></span></pre></div>
<span class="cx" style="display: block; padding: 0 10px">Index: trunk/docs/user/assets/bp-tools-reset-slugs.png
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- trunk/docs/user/assets/bp-tools-reset-slugs.png 2023-06-10 06:22:42 UTC (rev 13500)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ trunk/docs/user/assets/bp-tools-reset-slugs.png 2023-06-10 10:02:48 UTC (rev 13501)
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/docs/user/assets/bp-tools-reset-slugs.png
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span><a id="svnmimetype"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:mime-type</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+image/png
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunkdocsusermanifestjson"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/docs/user/manifest.json</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/docs/user/manifest.json (rev 0)
+++ trunk/docs/user/manifest.json 2023-06-10 10:02:48 UTC (rev 13501)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,38 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+[
+ {
+ "title": "User Handbook",
+ "slug": "handbook",
+ "markdown_source": "../user/README.md",
+ "parent": null
+ },
+ {
+ "title": "BuddyPress Administration",
+ "slug": "administration",
+ "markdown_source": "../user/administration/README.md",
+ "parent": null
+ },
+ {
+ "title": "BuddyPress settings",
+ "slug": "administration-settings",
+ "markdown_source": "../user/administration/settings/README.md",
+ "parent": null
+ },
+ {
+ "title": "BuddyPress URLs settings",
+ "slug": "administration-settings-urls",
+ "markdown_source": "../user/administration/settings/urls.md",
+ "parent": null
+ },
+ {
+ "title": "BuddyPress Administration Tools",
+ "slug": "administration-tools",
+ "markdown_source": "../user/administration/tools/README.md",
+ "parent": null
+ },
+ {
+ "title": "BuddyPress Repair Tool",
+ "slug": "administration-tools-repair",
+ "markdown_source": "../user/administration/settings/repair.md",
+ "parent": null
+ }
+]
</ins></span></pre>
</div>
</div>
</body>
</html>