Skip to main content

Todo

Here we will list all the To Do items we have for this project, and you can help by taking care of any of them :D.

Technical Reference​

Formatting To Dos​

Tables​

  • We need to format al the Tables to markdown.
    • This can probably be done programmatically for the most part
    • Most tables are preformatted an follow a similar pattern
    • Can check if it's a listing of dictionary items with a script similar to this one and if every item is a dictionary item, add the <DictionaryLink>item</DictionaryLink> wrapping to it and the link should just work
    • Need to figure out the styling to keep them to new lines, or maybe remove the <p></p> tags all together.
    • Most tables are either listings of dictionary items, or code blocks. Can then check what the rest of the tables are and how many are left to format to see if it makes sense to do a programmatic or manual approach to fixing them

Code Blocks​

  • Update lisp code to be wrapped in code blocks to be formated with markdown. Markdown supports math formulas and special text, checkout the Markdown Syntax tutorial for how to do it. Note that we use MDX instead of vanilla markdown.
    • 2023/12/06 Update: All the dictionary pages example sections were surrounded with code blocks for syntax highlighting, so therefore most of what's left are the code blocks in the write up sections of the reference.
  • Links to Sections like in See Also "Section 6.1.1.7 (Destructuring) "
    • These can be done programmatically as well, just have to map to the right page and to the right id
    • there's a script that does the mapping here: process-dpans3r I just forgot the name, it's the one that calls the python function ord
    • See how the id's are mapped by just navigating to any subsection in a reference page...

Extra New Lines​

  • Some Pages have new lines in the middle of parragraphs that need to be removed

File Names​

  • Rename files to have numbers in them? This can make it easier to find the right file for edditing. Careful not to chage the react component names however, that was the original reason everything was changed...

Extra Page Headers in Text​

  • Sometimes page header strings (chapter titles) with new lines were added in some parts of the text, they need to be removed... They can probably be removed programmatically...
    • Get the name of all the chapters. Then look for the string r'\s\n\s{chapter_name}\s\n\s' and delete it (AKA replace it with them empty string)
    • Manually check all deletions in your git diff tool to make sure they make sense and something valuable is not being deleted

Content To Dos​

New Sections​

Can you think of important topics to cover in the technical reference besides those that are in the specification and mop chapters 5 and 6? Or anything we have not yet covered? If so, please submit an issue or even better a pull request.

  • Concurrency is probably essential, so the bordeaux and maybe another library related to that
  • A lot of the trivial-* packages are probably also essential at this stage to programming in CL and they are independent (mostly) of the implementations, so it may make sense to include them
  • A table comparisons of the implementations, but then we would have to think what the relevant comparisons are. Any important comparisons between the implementations that are really important to know?
    • A table of trivial-* to implementation support is important

Tutorial​

We need help writing any of these sections:

Done​

  • All the Dictionary Sections have to be separated in the docs. For example, all of section 9.2 in the original is included in our 9.1. We need to split that file into two. Similarly for chapters
    • 3.8
    • 4.4
    • 5.3
    • 6.2
    • 7.7
    • 8.1?
    • 9.2
    • etc. It seems the last section of every chapter which is the Dictionary was bundled into the next to last section.
  • Fix the Dictionary Entry pages that were not parsed correctly.
  • Indent Common Lisp code blocks.
  • Break the Glossary into 27 pages, one per letter, plus the introduction and non alphabetical symbols page.
  • Add <ClLinks> wrapping to all italic and bolded text in the specification except for that inside code blocks and in titles, to provide links and tooltips...
  • Add Tooltips with definitions from the glossary everywhere that is relevant
    • The best way to do it is by creating a hash table of the dictionary, and everywhere an italizaed word is present, suroound it with a React Component which will check if there's a definition for that text in the glossary and it will add a tooltip if it's relevant
    • This should probably be a react component so that it can also be used in oher Lisp Docs pages and tutorials and shared easily across projects
    • Update the glossary to be HTML and not markdown
    • Finish all the dicionary item's parsing, then update the json files for the glossary and the dicionary terms
  • We should add links to all the bolded items in the reference to go to the appropiate pages. This should be actually fairly straight forward to do with code. We can just build a hash table of the dictionary pages available, with the name of each page, then simply find all the bolded text in the reference, and if its name matches an entry in the hash table, turn in into a link for that page.
  • Make the Tooltip Definition and links to dicionary pages
  • ~~Multiple Sidebars for: ~~
    • Contribute
    • Why Lisp Section: For beginners, professionals, CTOs or Project Managers
  • ~~In all code blocks: ~~
    • replace &gt; and &lt; with ><,
    • remove extra white lines script run...
    • run indent code blocks again
    • any place that is not inside a code block, or in a title, which is italics and or bold, add the react lisp-docs util...
    • get react router, test if it works, check base name, then do local route... Links...
    • go through all dictionary items, check that they are all there
  • make code blocks from sections named example which have figures...
    • title of section is examples
      • has a figure
    • no figure, then in that section, find first line which is either \n\s*( or \n\s;, and start code block from there till the end of the section