Skip to content

Commit

Permalink
doc: reorg part 6 - fix document references
Browse files Browse the repository at this point in the history
  • Loading branch information
cgay committed May 9, 2024
1 parent 93dd829 commit d15c24f
Show file tree
Hide file tree
Showing 15 changed files with 53 additions and 51 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ How to Contribute

If you would like to start contributing to Open Dylan, please see the `Open
Dylan Hacker's Guide <https://opendylan.org/hacker-guide/>`_ or open the file
`documentation/hacker-guide/source/index.rst` in this distribution for
`documentation/source/hacker-guide/index.rst` in this distribution for
guidelines and ideas on where to start. Thanks!
6 changes: 3 additions & 3 deletions documentation/source/community/gsoc/2012/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ This page is to help organize our (hopeful) participation in the Google
Summer of Code, 2012.

Submissions and edits to this content can be done by submitting a pull
request to the `website repository
<https://github.com/dylan-lang/website/>`_ or by :doc:`contacting us via
request to `Open Dylan
<https://github.com/dylan-lang/opendylan/>`_ or by :doc:`contacting us via
IRC or the mailing list </community/index>`.

If you are interested in being a mentor, please contact Bruce Mitchener
via one of the above means.

.. toctree::
:titlesonly:

dylint
javascript
tracing
Expand Down
2 changes: 1 addition & 1 deletion documentation/source/community/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ GitHub <https://gist.github.com>`_ and paste a link to it.
.. _contribute:

How to Contribute
The :doc:`Hacker Guide <../hacker-guide/source/index>` has details on how to
The :doc:`Hacker Guide <../hacker-guide/index>` has details on how to
contribute to the project.

Report Bugs
Expand Down
57 changes: 29 additions & 28 deletions documentation/source/documentation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ Documentation
Learn Dylan
===========

:doc:`../about/index`
:doc:`/about/index`
A quick overview of the language with examples of major features.

:doc:`../intro-dylan/source/index`
:doc:`/intro-dylan/index`
This tutorial is written primarily for those with solid programming
experience in C++ or another object-oriented, static language. It
provides a gentler introduction to Dylan than does the `Dylan Reference
Expand All @@ -17,15 +17,15 @@ Learn Dylan
`Dylan Programming Guide`_ [`pdf <https://opendylan.org/books/dpg/DylanProgramming.pdf>`__] [`epub <https://opendylan.org/books/dpg/DylanProgramming.epub>`__]
A book length Dylan tutorial.

:doc:`../getting-started-cli/source/index`
:doc:`/getting-started-cli/index`
Describes development using the Open Dylan command line tools
and editor integration (like emacs). This is mainly for
Linux, FreeBSD, and macOS users.

:doc:`../getting-started-ide/source/index`
:doc:`/getting-started-ide/index`
Describes Open Dylan's integrated development environment (Windows only).

:doc:`../building-with-duim/source/index`
:doc:`/building-with-duim/index`
Describes how to use DUIM (Dylan User Interface Manager),
the portable window programming toolkit. (Windows only.)

Expand All @@ -35,38 +35,38 @@ References
`Dylan Reference Manual`_ (`Errata`_)
The official definition of the Dylan language and standard library.

:doc:`../library-reference/source/index`
:doc:`/library-reference/index`
Reference docs for core libraries packaged with Open Dylan.

:doc:`../duim-reference/source/index`
:doc:`/duim-reference/index`
Describes the libraries forming DUIM (Dylan User Interface Manager),
the portable window programming toolkit. It complements
Building Applications Using DUIM. (Currently Windows only.)

:doc:`../corba-guide/source/index`
:doc:`/corba-guide/index`
A tutorial and reference for CORBA interoperability using the Open
Dylan ORB.

Articles
========

:doc:`../articles/macro-system` by Dustin Voss.
:doc:`/articles/macro-system` by Dustin Voss.
This article holds hard-won knowledge about how the Dylan macro system works
and how to work around some of the gotchas that may catch a macro writer.

:doc:`../articles/procedural-dylan/index` by Paul Haahr.
:doc:`/articles/procedural-dylan/index` by Paul Haahr.
This essay explores Dylan from the perspective of a programmer used to
traditional procedural languages, such as Pascal or C.

:doc:`../package/http/server/quickstart/index`
:doc:`/package/http/server/quickstart/index`
A quick introduction to web development in Dylan.

:doc:`../news/2011/12/12/dswank` by Hannes Mehnert.
:doc:`/news/2011/12/12/dswank` by Hannes Mehnert.
An exciting look at using DIME and emacs for Dylan development.
DIME is for Dylan what `SLIME <https://common-lisp.net/project/slime/>`_
is for Common Lisp.

:doc:`../articles/beyond-java`
:doc:`/articles/beyond-java`
A discussion of some of the advantages Dylan provides over Java, based on
Jason Trenouth's experience writing a CORBA IDL compiler in both Java and
Dylan. (Written around 2001 and Java now has better handling of numeric
Expand All @@ -78,7 +78,7 @@ Publications
See the `publications page <publications.html>`_ for a full list. Below are a
few highlighted publications.

**LLVM Code Generation for Open Dylan** (by Peter Housel at ELS 2020 `pdf <https://zenodo.org/record/3742567/files/els2020-opendylan.pdf?download=1>`__ `bib <../_static/documentation/housel_peter_s_2020_3742567.bib>`__ `slides <https://european-lisp-symposium.org/static/2020/housel-slides.pdf>`__ `video <https://www.youtube.com/watch?v=6dcrXBzw4H4>`__)
**LLVM Code Generation for Open Dylan** (by Peter Housel at ELS 2020 `pdf <https://zenodo.org/record/3742567/files/els2020-opendylan.pdf?download=1>`__ `bib </_static/documentation/housel_peter_s_2020_3742567.bib>`__ `slides <https://european-lisp-symposium.org/static/2020/housel-slides.pdf>`__ `video <https://www.youtube.com/watch?v=6dcrXBzw4H4>`__)
The Open Dylan compiler, DFMC, was originally designed in the 1990s
to compile Dylan language code targeting the 32-bit Intel x86
platform, or other platforms via portable C. As platforms have
Expand All @@ -96,7 +96,7 @@ few highlighted publications.

https://doi.org/10.5281/zenodo.3742567

**Extending Dylan's type system for better type inference and error detection** (by Hannes Mehnert at ILC 2010 `pdf <http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.627.5175&rep=rep1&type=pdf>`__ `bib <../_static/documentation/mehnert2010.bib>`__)
**Extending Dylan's type system for better type inference and error detection** (by Hannes Mehnert at ILC 2010 `pdf <http://citeseerx.ist.psu.edu/viewdoc/download?doi=10.1.1.627.5175&rep=rep1&type=pdf>`__ `bib </_static/documentation/mehnert2010.bib>`__)
Whereas dynamic typing enables rapid prototyping and easy
experimentation, static typing provides early error detection and
better compile time optimization. Gradual typing provides the best
Expand All @@ -116,7 +116,7 @@ few highlighted publications.

https://dl.acm.org/doi/10.1145/1869643.1869645

**D-Expressions: Lisp Power, Dylan Style** [`pdf <http://people.csail.mit.edu/jrb/Projects/dexprs.pdf>`__] [`bib <../_static/documentation/bachrach1999.bib>`__]
**D-Expressions: Lisp Power, Dylan Style** [`pdf <http://people.csail.mit.edu/jrb/Projects/dexprs.pdf>`__] [`bib </_static/documentation/bachrach1999.bib>`__]
This paper aims to demonstrate that it is possible for a language
with a rich, conventional syntax to provide Lisp-style macro power
and simplicity. We describe a macro system and syntax manipulation
Expand All @@ -132,18 +132,18 @@ For Open Dylan Developers
.. note:: Notes and materials useful to those working on Open Dylan itself or
those who have an interest in the low level details.

:doc:`../hacker-guide/source/index`
:doc:`/hacker-guide/index`
A work in progress to help out people who are hacking on Open Dylan itself.

:doc:`../style-guide/source/index`
:doc:`/style-guide/index`
Notes and thoughts on how to format your Dylan code. This is the style
guide that we aspire to adhere to in the Open Dylan sources.

:doc:`../proposals/index`
:doc:`/proposals/index`
A series of proposals for improvements to the Open Dylan
implementation and related libraries.

:doc:`../release-notes/source/index`
:doc:`/release-notes/index`
Notes on new features and bug fixes in each release of Open Dylan.


Expand All @@ -157,14 +157,15 @@ For Open Dylan Developers
.. toctree::
:hidden:

News <../news/index>
News </news/index>
Cheat Sheets <cheatsheets/index>
Publications <publications>
Intro to Dylan <../intro-dylan/source/index>
CORBA Guide <../corba-guide/source/index>
DUIM Guide <../building-with-duim/source/index>
DUIM Reference <../duim-reference/source/index>
Getting Started / IDE <../getting-started-ide/source/index>
Release Notes <../release-notes/source/index>
Intro to Dylan </intro-dylan/index>
CORBA Guide </corba-guide/index>
DUIM Guide </building-with-duim/index>
DUIM Reference </duim-reference/index>
Getting Started / IDE </getting-started-ide/index>
Release Notes </release-notes/index>
Sphinx Extensions <../../sphinx-extensions/documentation/source/index>
Style Guide <../style-guide/source/index>
Style Guide </style-guide/index>
History </history/index>
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ now here is a manual check-list.
backup on a server that we own.)

#. Update the `Downloads
<https://github.com/dylan-lang/website/blob/master/source/download/index.rst>`_
<https://github.com/dylan-lang/opendylan/blob/master/documentation/source/download/index.rst>`_
page.

#. On GitHub, move the release from Draft to Final.
Expand Down
9 changes: 5 additions & 4 deletions documentation/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ how to define libraries and modules right away.

Then move on to one of these in-depth guides:

* :doc:`intro-dylan/source/index` provides a high-level overview of language
* :doc:`/intro-dylan/index` provides a high-level overview of language
features.
* `Dylan Programming Guide`_ is a book length Dylan tutorial.

Expand Down Expand Up @@ -83,17 +83,18 @@ articles, and all the library docs.

Get Involved <community/index>
Download <download/index>
Hacker Guide <hacker-guide/source/index>
Hacker Guide <hacker-guide/index>
Enhancement Proposals <proposals/index>

.. toctree::
:caption: Learning
:hidden:

Tour of Dylan <about/index>
Getting Started Guide <getting-started-cli/source/index>
Getting Started Guide <getting-started-cli/index>
Dylan Programming Guide <https://opendylan.org/books/dpg/>
Dylan Playground <https://play.opendylan.org>
Cheat Sheets <documentation/cheatsheets/index>

.. Note that the package/index reference below is not part of this
repository; it's generated by the gendoc library, which (obviously)
Expand All @@ -105,6 +106,6 @@ articles, and all the library docs.

Dylan Reference Manual <https://opendylan.org/books/drm/>
Package Docs <package/index>
Open Dylan Libraries <library-reference/source/index>
Open Dylan Libraries <library-reference/index>
All Documentation <documentation/index>
Full Index <genindex>
2 changes: 1 addition & 1 deletion documentation/source/library-reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This reference describes the libraries provided with Open Dylan, either as part
of the "opendylan" repository or included therein as submodules. It also
documents Dylan language extensions and the LID file format.

See the :doc:`Dylan Package Docs <../package/index>` for documentation
See the :doc:`Dylan Package Docs </package/index>` for documentation
on published Dylan packages.

Contents:
Expand Down
6 changes: 3 additions & 3 deletions documentation/source/news/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Release 2023.1
* Updated versions of LLVM and the BDW garbage collector.
* New ``"""multi-line"""`` and ``#r"raw"`` string literals (`DEP 12
<../proposals/dep-0012-string-literals.rst>`_).
* The :doc:`dylan <../package/dylan-tool/index>` tool continues to evolve with
* The :doc:`dylan </package/dylan-tool/index>` tool continues to evolve with
a new, simplified workspace model.
* Bug fixes for json, command-line-parser, system, and others.

Expand All @@ -38,15 +38,15 @@ overhaul. The goals of this revamp were:
#. Local table of contents in the right sidebar. Hooray `Furo
<https://pradyunsg.me/furo/quickstart/>`_!

#. Integrated :doc:`package docs <../package/index>`.
#. Integrated :doc:`package docs </package/index>`.

#. Simplicity! We're a small team so we want to avoid any extra maintenance
burden. To that end, we no longer use a Dylan-specific Sphinx theme or
templates. If it ain't in `Furo <https://pradyunsg.me/furo/quickstart/>`_,
we don't want it! :-)

We'd love to hear feedback on the new site. You can `file a bug
<https://github.com/dylan-lang/website/issues>`_ or `drop us a note on Matrix
<https://github.com/dylan-lang/opendylan/issues>`_ or `drop us a note on Matrix
<https://app.element.io/#/room/#dylan-language:matrix.org>`_.


Expand Down
4 changes: 2 additions & 2 deletions documentation/source/proposals/dep-0001-dep-process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ the next available DEP number to the DEP by looking at the :doc:`DEP
directory <index>` to find the highest used number. The DEP
number is not assured until the DEP has been committed to the `origin
Git repository
<https://github.com/dylan-lang/website/tree/master/source/proposals>`_.
<https://github.com/dylan-lang/opendylan/tree/master/documentation/source/proposals>`_.
As updates are necessary, the DEP author may commit new versions.

Wait for at least ten days to receive feedback on each draft.
Expand Down Expand Up @@ -487,7 +487,7 @@ References and Footnotes
.. [1] This historical record is available by the normal Git commands
for retrieving older revisions. For those without direct access to
Git, you can browse the current and past DEP revisions here:
https://github.com/dylan-lang/website/tree/master/source/proposals
https://github.com/dylan-lang/opendylan/tree/master/documentation/source/proposals
.. [2] Which issue tracker to use will depend on the content of the
DEP. For language changes, changes to Open Dylan, or changes to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Revision History
================

The revision history of this document is available on GitHub:
https://github.com/dylan-lang/website/commits/master/source/proposals/dep-0006-single-file-library.rst
https://github.com/dylan-lang/opendylan/commits/master/documentation/source/proposals/dep-0006-single-file-library.rst

Abstract
========
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,4 +120,4 @@ Revision History
================

The revision history of this document is available here:
https://github.com/dylan-lang/website/commits/master/source/proposals/dep-0008-multi-line-strings.rst
https://github.com/dylan-lang/opendylan/commits/master/documentation/source/proposals/dep-0008-multi-line-strings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Revision History
================

The revision history of this document is available here:
https://github.com/dylan-lang/website/commits/master/source/proposals/dep-0010-element-otherwise.rst
https://github.com/dylan-lang/opendylan/commits/master/documentation/source/proposals/dep-0010-element-otherwise.rst

Abstract
========
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -355,4 +355,4 @@ Revision History
================

The revision history of this document is available here:
https://github.com/dylan-lang/website/commits/master/source/proposals/dep-0012-string-literals.rst
https://github.com/dylan-lang/opendylan/commits/master/documentation/source/proposals/dep-0012-string-literals.rst
4 changes: 2 additions & 2 deletions documentation/source/proposals/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ building consensus within the community and documenting dissenting opinions.

Because the DEPs are maintained as text files in a versioned repository, their
`revision history
<https://github.com/dylan-lang/website/tree/master/source/proposals>`_ is the
historical record of the feature proposal.
<https://github.com/dylan-lang/opendylan/tree/master/documentation/source/proposals>`_
is the historical record of the feature proposal.

For more information on the DEP process, see DEP 1,
:doc:`dep-0001-dep-process`.
Expand Down
2 changes: 1 addition & 1 deletion sources/lib/run-time/demangle.c
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
#define ARRAY_LEN(x) (sizeof(x)/sizeof((x)[0]))

// This is adequate for IEPs, but could be improved for other things
// See documentation/hacker-guide/source/runtime/mangling.rst
// See documentation/source/hacker-guide/runtime/mangling.rst
int dylan_demangle(char *dest, size_t destsize, char *src)
{
if (destsize == 0) {
Expand Down

0 comments on commit d15c24f

Please sign in to comment.