updates

usethesource · May 25, 2023 · 5d1127e · 5d1127e
1 parent 1b2f72a
commit 5d1127e
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 6 deletions.
diff --git a/about/architecture.md b/about/architecture.md
@@ -11,18 +11,21 @@ The decisions and the fact that they are shared among the projects is motivated
 
 * We try to avoid external dependencies, and use the JVM as much as possible;
 * External dependencies we resolve using the maven grand central (no embedded jars) or standard Eclipse update sites;
-* Eclipse Luna for IDE features and UI integration.
+* VScode is the default for IDE features
+* Next is Eclipse IDE features and UI integration.
+* We use HTML5 for visuals
 
 ## Continuous Integration and Testing
 
-* We run all projects on the UseTheSource Jenkins instance;
-* Builds are triggered automatically after a push to github.
+* We run all projects on the GitHub Actions instance;
+* Builds are triggered automatically after a push to GitHub.
 
 ## Version Management
 
 * All projects use git;
+* All projects have `main` as the main development branch;
 * All projects are hosted on github in the usethesource organization;
-* All features are developed on a branch different from `master`;
+* All features are developed on a branch different from `main` (i.e. a pull request btanch);
 * A new `master` is pushed only if the unit tests have been run successfully;
 * Github issue id's are used in commit messages `fixes #23`.
 
@@ -36,10 +39,12 @@ The issue tracking system is used as task list and issue management system at th
 
 ## Release and Deployment 
 
-* All projects are continuously released on the `unstable` update site and maven repository (add link);
+* All projects are continuously integrated with SNAPSHOT versions, but these dependecies can not be used outside of the single project.
 * Projects have an independent release and deployment cycle when possible; but if dependencies are broken then release and deployment is synchronised;
 * External dependencies which are not on the Eclipse standard update sites and not in the Maven Grand Central get a separate feature released indepedently on our update site.
 
 ## Websites
 
 * We use github pages and a common infrastructure (add link) for each project's website.
+* http://www.rascal-mpl.org is the home of Rascal and other (third-party) contributions to the Rascal package ecosystem.
+* http://www.usethesource.io is the home of the UseTheSource organization.
diff --git a/about/coding.md b/about/coding.md
@@ -21,7 +21,8 @@ These are guidelines for code style and quality that we follow at UseTheSource.
 
 ## Rascal
 
-* all public functions have @doc tags in Rascal tutor format.
+* all public functions have @synopsis tags in Rascal tutor format.
+* most public functions have @description and @examples tags in Rascal tutor format.
 * tools for languages reside in `lang/<language name>/<sub?>/<tool name>.rsc`
 * generic algorithms for analysis reside in `analysis/<algorithm group>/<algorithm>.rsc`
 * generic utilities (i.e. for communication) reside in `utils/<utility>.rsc`