Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Synergy.Documentation library #27

Open
MarcinCelej opened this issue May 14, 2023 · 0 comments
Open

Add Synergy.Documentation library #27

MarcinCelej opened this issue May 14, 2023 · 0 comments

Comments

@MarcinCelej
Copy link
Member

  • Public Api generator
  • TODO as technical debt listing
MarcinCelej added a commit that referenced this issue May 15, 2023
@MarcinCelej
#27: Managed debt for Synergy.Documentation library
535d983
MarcinCelej added a commit that referenced this issue May 15, 2023
@MarcinCelej
#27: Updated class for generating Class Documentation (in form of mar…
02989b0 
…kdown)
MarcinCelej added a commit that referenced this issue May 15, 2023
@MarcinCelej
#27: Added ApiDescription class for generating library Public Api in …
0161852 
…form of markdown
MarcinCelej added a commit that referenced this issue May 15, 2023
@MarcinCelej
#27: Updated some helper classes
580cc70
MarcinCelej added a commit that referenced this issue May 15, 2023
@MarcinCelej
#27: Removed some unused reference in Synergy.Documentation project
bf65d9c
MarcinCelej added a commit that referenced this issue Dec 20, 2023
@MarcinCelej
#27: Refactor and update CodeFile logic
4383142 
The wrong usage of "this" has been corrected, and filePath is now explicitly passed to OrFailIfWhiteSpace for error throw purposes. Invalid path argument exception mechanism is also introduced in Folder property to handle exceptional cases more effectively.
MarcinCelej added a commit that referenced this issue Dec 20, 2023
@MarcinCelej
#27: Update CodeFolder.cs to handle null or invalid paths
cfd0efb 
The CodeFolder class in the Synergy.Documentation project has been updated to throw exceptions when a null or invalid path is passed to it. Additionally, the separator in the "Up" method was flipped from "\\" to "/". The changes improve code robustness and cross-platform compatibility.
MarcinCelej added a commit that referenced this issue Dec 20, 2023
@MarcinCelej
#27: Refactoring of Markdown.cs
3bec3b3 
Noticeable formatting adjustments are made, like adding more spacing and irregular indentation fixes. Changes are also made in each region including Headers, Paragraph, and Code for better organization and readability.
MarcinCelej added a commit that referenced this issue Dec 20, 2023
@MarcinCelej
#27: Add Image support to Markdown class
6db02db 
A new `Image` class is added inside the `Markdown` class, within the `Documentation` project. This class facilitates incorporating images in markdown files, handling file paths and providing a way to specify alternate text for an image. Also, it allows to specify the image path relative to a specific file.
MarcinCelej added a commit that referenced this issue Dec 20, 2023
@MarcinCelej
#27: Remove outdated TODO comment in CodeFile
0c5498b 
This commit removes a superfluous TODO comment from the CodeFile class. The comment was relevant to a contract check that has already been fixed, hence it's no longer necessary.
MarcinCelej added a commit that referenced this issue Dec 20, 2023
@MarcinCelej
#27: Update Synergy.Documentation project settings
61ae423 
Several project settings have been updated in the Synergy.Documentation.csproj file. Those are nuget package settings.
MarcinCelej added a commit that referenced this issue Dec 21, 2023
@MarcinCelej
#27: Update package project URL in csproj file
74bc505 
The link for PackageProjectUrl has been updated in the Synergy.Documentation.csproj file. It previously pointed to a specific wiki page, but has now been changed to point to the root of the wiki to give a more generalized access to the overall project documentation.
MarcinCelej added a commit that referenced this issue Dec 21, 2023
@MarcinCelej
#27: Changed order of types and methods in generated api description
3fcce90
MarcinCelej added a commit that referenced this issue Dec 21, 2023
@MarcinCelej
#27: Introduced Markdown.Link class
6d7c472
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Removed dependency between Synergy.Documentation and Synergy.Con…
9a1346a 
…tracts
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: First version of README.md for Synergy.Documentation project
c86c896 
Contains description of TodoExplorer usage to enlist technical debt inside the projects.
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: First version of README.md for Synergy.Documentation project
521bd77 
Contains description of TodoExplorer usage to enlist technical debt inside the projects.
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Additional TODO in TodoExplorer to add pattern for TODOs inside …
390e6c0 
…the markdown files
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Additional TODOs in MarkdownTests to add tests for newly added c…
6d56374 
…lasses
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Added first version of Dependencies finder
cb7b745
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Added test with verification of external libraries public API.
aa1d219
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: TODOs technical debt regenerated
c79351e
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Updated README.md for Synergy.Documentation project
a8ded93
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Added version number to public api description of external packages
66de959
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Fixed test of generating markdown document
6c79451
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Removed not needed R# file
8e8261a
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Added documentation for generating documentation for a specific …
f39e788 
…class with its dependencies.
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: introduced ability to create api description for specific class …
afb020c 
…with its nested classes.
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Added method CodeFile.Sub() to create a subfolder of code.
e877443
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Removed some not needed TODOs
faf8d3e
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Renamed method for creating relative Markdown.Link object
477b0e9
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Added method for reading CodeFile content
fbf3626
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Introduced README.md automatic generation (Docs As Code) for Syn…
ef709ca 
…ergy.Documentation nuget package
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Introduced README.md automatic generation (Docs As Code) for Syn…
826e4db 
…ergy.Documentation nuget package
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Fixed error in creating current CodeFile
c6eaf2a
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Markdown.Link implements Markdown.IElement interface now
05add94
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Added test of generating Markdown.Link
ed7446e
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Renamed method creating Markdown.Image relative file path
be3a793
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Added test of generating Markdown.Image
e20542f
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Removed not used file
4651195
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Introduced Synergy.Documentation.Annotations.csproj
24cf8a7
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Added [CodeFilePath] attribute
5709d50
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Introduced README.md automatic generation (Docs As Code) for Syn…
d39da85 
…ergy.Documentation nuget package
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Added public API verification for Synergy.Documentation.Annotati…
f776db4 
…ons nuget package
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Add class Note to add comments into code as extensions
c9b07a4
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Introduced README.md automatic generation (Docs As Code) for Syn…
d5e40d6 
…ergy.Documentation nuget package
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Added some TODOs to extend TODO explorer patterns
7574696
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Introduced TODO finding pattern for csproj files
f261b78 
It searches for TODOs in *.csproj files
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Additional net frameworks to Documentation projects
2b188fc 
Added support for net6.0; net7.0; net8.0;
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: trailing comment signs now are removed from TODO embedded in csp…
5e8bf1a 
…roj file
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Added TODOs into Synergy.Documentation.csproj
6b2823d
MarcinCelej added a commit that referenced this issue Jan 10, 2024
@MarcinCelej
#27: Synergy.Documentation: Added some TODOs to be finished later
d118cb1
MarcinCelej added a commit that referenced this issue Jan 18, 2024
@MarcinCelej
#27: Synergy.Documentation: Reordered headers in README.md
303645b
MarcinCelej added a commit that referenced this issue Jan 18, 2024
@MarcinCelej
#27: Synergy.Documentation: Added description of using Comments As Co…
f5b8076 
…de into README.md
MarcinCelej added a commit that referenced this issue Jan 18, 2024
@MarcinCelej
#27: Synergy.Documentation: Updated README.md
daecc62
MarcinCelej added a commit that referenced this issue Jan 18, 2024
@MarcinCelej
#27: Synergy.Documentation: !Init folder isn't namespace provider any…
a748c70 
…more
MarcinCelej added a commit that referenced this issue Jan 18, 2024
@MarcinCelej
#27: Added CodeFile.ChangeExtension() method
f6fba6a
MarcinCelej added a commit that referenced this issue Jan 18, 2024
@MarcinCelej
#27: Synergy.Documentation: Added links to nuget packages into README.md
e453297
MarcinCelej added a commit that referenced this issue Jan 18, 2024
@MarcinCelej
#27: Synergy.Documentation: Fixed TODO pattern finder for *.csproj files
5c3730c
MarcinCelej added a commit that referenced this issue May 16, 2024
@MarcinCelej
#27: Synergy.Documentation: Changed link to docs
f58ff00 
<PackageProjectUrl> point version 3.0.4 of docs now
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@MarcinCelej